draft-ietf-i2nsf-capability-data-model-16.txt   draft-ietf-i2nsf-capability-data-model-17.txt 
I2NSF Working Group S. Hares, Ed. I2NSF Working Group S. Hares, Ed.
Internet-Draft Huawei Internet-Draft Huawei
Intended status: Standards Track J. Jeong, Ed. Intended status: Standards Track J. Jeong, Ed.
Expires: September 9, 2021 J. Kim Expires: 15 February 2022 J. Kim
Sungkyunkwan University Sungkyunkwan University
R. Moskowitz R. Moskowitz
HTT Consulting HTT Consulting
Q. Lin Q. Lin
Huawei Huawei
March 8, 2021 14 August 2021
I2NSF Capability YANG Data Model I2NSF Capability YANG Data Model
draft-ietf-i2nsf-capability-data-model-16 draft-ietf-i2nsf-capability-data-model-17
Abstract Abstract
This document defines an information model and the corresponding YANG This document defines an information model and the corresponding YANG
data model for the capabilities of various Network Security Functions data model for the capabilities of various Network Security Functions
(NSFs) in the Interface to Network Security Functions (I2NSF) (NSFs) in the Interface to Network Security Functions (I2NSF)
framework to centrally manage the capabilities of the various NSFs. framework to centrally manage the capabilities of the various NSFs.
Status of This Memo Status of This Memo
skipping to change at page 1, line 39 skipping to change at page 1, line 39
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on September 9, 2021. This Internet-Draft will expire on 15 February 2022.
Copyright Notice Copyright Notice
Copyright (c) 2021 IETF Trust and the persons identified as the Copyright (c) 2021 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents (https://trustee.ietf.org/
(https://trustee.ietf.org/license-info) in effect on the date of license-info) in effect on the date of publication of this document.
publication of this document. Please review these documents Please review these documents carefully, as they describe your rights
carefully, as they describe your rights and restrictions with respect and restrictions with respect to this document. Code Components
to this document. Code Components extracted from this document must extracted from this document must include Simplified BSD License text
include Simplified BSD License text as described in Section 4.e of as described in Section 4.e of the Trust Legal Provisions and are
the Trust Legal Provisions and are provided without warranty as provided without warranty as described in the Simplified BSD License.
described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. Capability Information Model Design . . . . . . . . . . . . . 4 3. Information Model of I2NSF NSF Capability . . . . . . . . . . 4
3.1. Design Principles and ECA Policy Model Overview . . . . . 5 3.1. Design Principles and ECA Policy Model . . . . . . . . . 5
3.2. Matched Policy Rule . . . . . . . . . . . . . . . . . . . 8 3.2. Conflict, Resolution Strategy and Default Action . . . . 8
3.3. Conflict, Resolution Strategy and Default Action . . . . 8 4. Overview of YANG Data Model . . . . . . . . . . . . . . . . . 10
4. Overview of YANG Data Model . . . . . . . . . . . . . . . . . 9
5. YANG Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 12 5. YANG Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 12
5.1. Network Security Function (NSF) Capabilities . . . . . . 12 5.1. Network Security Function (NSF) Capabilities . . . . . . 12
6. YANG Data Model of I2NSF NSF Capability . . . . . . . . . . . 15 6. YANG Data Model of I2NSF NSF Capability . . . . . . . . . . . 15
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 59 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 48
8. Privacy Considerations . . . . . . . . . . . . . . . . . . . 59 8. Privacy Considerations . . . . . . . . . . . . . . . . . . . 49
9. Security Considerations . . . . . . . . . . . . . . . . . . . 60 9. Security Considerations . . . . . . . . . . . . . . . . . . . 49
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 60 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 51
10.1. Normative References . . . . . . . . . . . . . . . . . . 60 10.1. Normative References . . . . . . . . . . . . . . . . . . 51
10.2. Informative References . . . . . . . . . . . . . . . . . 65 10.2. Informative References . . . . . . . . . . . . . . . . . 55
Appendix A. Configuration Examples . . . . . . . . . . . . . . . 67 Appendix A. Configuration Examples . . . . . . . . . . . . . . . 57
A.1. Example 1: Registration for the Capabilities of a General A.1. Example 1: Registration for the Capabilities of a General
Firewall . . . . . . . . . . . . . . . . . . . . . . . . 67 Firewall . . . . . . . . . . . . . . . . . . . . . . . . 57
A.2. Example 2: Registration for the Capabilities of a Time- A.2. Example 2: Registration for the Capabilities of a
based Firewall . . . . . . . . . . . . . . . . . . . . . 70 Time-based Firewall . . . . . . . . . . . . . . . . . . . 59
A.3. Example 3: Registration for the Capabilities of a Web A.3. Example 3: Registration for the Capabilities of a Web
Filter . . . . . . . . . . . . . . . . . . . . . . . . . 72 Filter . . . . . . . . . . . . . . . . . . . . . . . . . 61
A.4. Example 4: Registration for the Capabilities of a A.4. Example 4: Registration for the Capabilities of a VoIP/
VoIP/VoLTE Filter . . . . . . . . . . . . . . . . . . . . 72 VoLTE Filter . . . . . . . . . . . . . . . . . . . . . . 61
A.5. Example 5: Registration for the Capabilities of a HTTP A.5. Example 5: Registration for the Capabilities of a HTTP and
and HTTPS Flood Mitigator . . . . . . . . . . . . . . . . 73 HTTPS Flood Mitigator . . . . . . . . . . . . . . . . . . 62
Appendix B. Acknowledgments . . . . . . . . . . . . . . . . . . 74 Appendix B. Acknowledgments . . . . . . . . . . . . . . . . . . 63
Appendix C. Contributors . . . . . . . . . . . . . . . . . . . . 75 Appendix C. Contributors . . . . . . . . . . . . . . . . . . . . 64
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 77 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 65
1. Introduction 1. Introduction
As the industry becomes more sophisticated and network devices (e.g., As the industry becomes more sophisticated and network devices (e.g.,
Internet-of-Things (IoT) devices, autonomous vehicles, and Internet-of-Things (IoT) devices, autonomous vehicles, and
smartphones using Voice over IP (VoIP) and Voice over LTE (VoLTE)) smartphones using Voice over IP (VoIP) and Voice over LTE (VoLTE))
require advanced security protection in various scenario, service require advanced security protection in various scenarios, security
providers have a lot of problems described in [RFC8192]. To resolve service providers have a lot of problems described in [RFC8192] to
these problems, this document specifies the information and data provide such network devices with efficient and reliable security
models of the capabilities of Network Security Functions (NSFs) in a services in network infrastructure. To resolve these problems, this
framework of the Interface to Network Security Functions (I2NSF) document specifies the information and data models of the
[RFC8329]. capabilities of Network Security Functions (NSFs) in a framework of
the Interface to Network Security Functions (I2NSF) [RFC8329].
NSFs produced by multiple security vendors provide various security NSFs produced by multiple security vendors provide various security
capabilities to customers. Multiple NSFs can be combined together to capabilities to customers. Multiple NSFs can be combined together to
provide security services over the given network traffic, regardless provide security services over the given network traffic, regardless
of whether the NSFs are implemented as physical or virtual functions. of whether the NSFs are implemented as physical or virtual functions.
Security Capabilities describe the functions that Network Security Security Capabilities describe the functions that Network Security
Functions (NSFs) are available to provide for security policy Functions (NSFs) can provide for security policy enforcement.
enforcement purposes. Security Capabilities are independent of the Security Capabilities are independent of the actual security policy
actual security control mechanisms that will implement them. that will implement the functionality of the NSF.
Every NSF SHOULD be described with the set of capabilities it offers. Every NSF SHOULD be described with the set of capabilities it offers.
Security Capabilities enable security functionality to be described Security Capabilities enable security functionality to be described
in a vendor-neutral manner. That is, it is not needed to refer to a in a vendor-neutral manner. Security Capabilities are a market
specific product or technology when designing the network; rather, enabler, providing a way to define customized security protection by
the functions characterized by their capabilities are considered. unambiguously describing the security features offered by a given
Security Capabilities are a market enabler, providing a way to define NSF. Note that this YANG data model structurizes the NSF Monitoring
customized security protection by unambiguously describing the Interface YANG data model [I-D.ietf-i2nsf-nsf-monitoring-data-model]
security features offered by a given NSF. Note that this YANG data and the NSF-Facing Interface YANG Data Model
model outlines an NSF monitoring YANG data model [I-D.ietf-i2nsf-nsf-facing-interface-dm].
[I-D.ietf-i2nsf-nsf-monitoring-data-model] and a YANG data model for
Software-Defined Networking (SDN)-based IPsec flow protection
[I-D.ietf-i2nsf-sdn-ipsec-flow-protection].
This document provides an information model and the corresponding This document provides an information model and the corresponding
YANG data model [RFC6020][RFC7950] that defines the capabilities of YANG data model [RFC6020][RFC7950] that defines the capabilities of
NSFs to centrally manage the capabilities of those security devices. NSFs to centrally manage the capabilities of those NSFs. The NSFs
The security devices can register their own capabilities into a can register their own capabilities into a Network Operator
Network Operator Management (Mgmt) System (i.e., Security Controller) Management (Mgmt) System (i.e., Security Controller) with this YANG
with this YANG data model through the registration interface data model through the registration interface [RFC8329]. With the
[RFC8329]. With the database of the capabilities of those security database of the capabilities of those NSFs that are maintained
devices that are maintained centrally, those security devices can be centrally, those NSFs can be more easily managed [RFC8329].
more easily managed [RFC8329].
This YANG data model uses an "Event-Condition-Action" (ECA) policy This YANG data model uses an "Event-Condition-Action" (ECA) policy
model that is used as the basis for the design of I2NSF Policy as model that is used as the basis for the design of I2NSF Policy as
described in [RFC8329] and Section 3.1. The "ietf-i2nsf-capability" described in [RFC8329] and Section 3.1. The "ietf-i2nsf-capability"
YANG module defined in this document provides the following features: YANG module defined in this document provides the following features:
o Definition for time capabilities of network security functions. * Definition for event capabilities of network security functions.
o Definition for event capabilities of generic network security
functions.
o Definition for condition capabilities of generic network security
functions.
o Definition for condition capabilities of advanced network security * Definition for condition capabilities of network security
functions. functions.
o Definition for action capabilities of generic network security * Definition for action capabilities of network security functions.
functions.
o Definition for resolution strategy capabilities of generic network * Definition for resolution strategy capabilities of network
security functions. security functions.
o Definition for default action capabilities of generic network * Definition for default action capabilities of network security
security functions. functions.
2. Terminology 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 uses the terminology described in [RFC8329].
This document follows the guidelines of [RFC8407], uses the common This document follows the guidelines of [RFC8407], uses the common
YANG types defined in [RFC6991], and adopts the Network Management YANG types defined in [RFC6991], and adopts the Network Management
Datastore Architecture (NMDA). The meaning of the symbols in tree Datastore Architecture (NMDA). The meaning of the symbols in tree
diagrams is defined in [RFC8340]. diagrams is defined in [RFC8340].
3. Capability Information Model Design 3. Information Model of I2NSF NSF Capability
A Capability Information Model (CapIM) is a formalization of the This section provides the I2NSF Capability Information Model (CapIM).
functionality that an NSF advertises. This enables the precise A CapIM is a formalization of the functionality that an NSF
specification of what an NSF can do in terms of security policy advertises. This enables the precise specification of what an NSF
enforcement, so that computer-based tasks can unambiguously refer to, can do in terms of security policy enforcement, so that computer-
use, configure, and manage NSFs. Capabilities MUST be defined in a based tasks can unambiguously refer to, use, configure, and manage
vendor- and technology-independent manner (e.g., regardless of the NSFs. Capabilities MUST be defined in a vendor- and technology-
differences among vendors and individual products). independent manner (e.g., regardless of the differences among vendors
and individual products).
Humans can refer to categories of security controls and understand Humans can refer to categories of security controls and understand
each other. For instance, network security experts agree on what is each other. For instance, network security experts agree on what is
meant by the terms "NAT", "filtering", and "VPN concentrator". As a meant by the terms "NAT", "filtering", and "VPN concentrator". As a
further example, network security experts unequivocally refer to further example, network security experts unequivocally refer to
"packet filters" as stateless devices that allow or deny packet "packet filters" as stateless devices that allow or deny packet
forwarding based on various conditions (e.g., source and destination forwarding based on various conditions (e.g., source and destination
IP addresses, source and destination ports, and IP protocol type IP addresses, source and destination ports, and IP protocol type
fields) [Alshaer]. fields) [Alshaer].
skipping to change at page 5, line 26 skipping to change at page 5, line 35
formal description of NSF functionality. The set of functions that formal description of NSF functionality. The set of functions that
are advertised MAY be restricted according to the privileges of the are advertised MAY be restricted according to the privileges of the
user or application that is viewing those functions. I2NSF user or application that is viewing those functions. I2NSF
Capabilities enable unambiguous specification of the security Capabilities enable unambiguous specification of the security
capabilities available in a (virtualized) networking environment, and capabilities available in a (virtualized) networking environment, and
their automatic processing by means of computer-based techniques. their automatic processing by means of computer-based techniques.
This CapIM includes enabling a security controller in an I2NSF This CapIM includes enabling a security controller in an I2NSF
framework [RFC8329] to properly identify and manage NSFs, and allow framework [RFC8329] to properly identify and manage NSFs, and allow
NSFs to properly declare their functionality through a Developer's NSFs to properly declare their functionality through a Developer's
Management System (DMS) [RFC8329] , so that they can be used in the Management System (DMS) [RFC8329], so that they can be used in the
correct way. correct way.
3.1. Design Principles and ECA Policy Model Overview 3.1. Design Principles and ECA Policy Model
-po This document defines an information model for representing NSF This document defines an information model for representing NSF
capabilities. Some basic design principles for security capabilities capabilities. Some basic design principles for security capabilities
and the systems that manage them are: and the systems that manage them are:
o Independence: Each security capability SHOULD be an independent * Independence: Each security capability SHOULD be an independent
function, with minimum overlap or dependency on other function, with minimum overlap or dependency on other
capabilities. This enables each security capability to be capabilities. This enables each security capability to be
utilized and assembled together freely. More importantly, changes utilized and assembled together freely. More importantly, changes
to one capability SHOULD NOT affect other capabilities. This to one capability SHOULD NOT affect other capabilities. This
follows the Single Responsibility Principle [Martin] [OODSRP]. follows the Single Responsibility Principle [Martin] [OODSRP].
o Abstraction: Each capability MUST be defined in a vendor- * Abstraction: Each capability MUST be defined in a vendor-
independent manner. independent manner.
o Advertisement: A dedicated, well-known interface MUST be used to * Advertisement: Registration Interface
[I-D.ietf-i2nsf-registration-interface-dm] MUST be used to
advertise and register the capabilities of each NSF. This same advertise and register the capabilities of each NSF. This same
interface MUST be used by other I2NSF Components to determine what interface MUST be used by other I2NSF Components to determine what
Capabilities are currently available to them. Capabilities are currently available to them.
o Execution: Dedicated, well-known interfaces MUST be used to * Execution: NSF-Facing Interface
configure and monitor the use of a capability, resepectively. [I-D.ietf-i2nsf-nsf-facing-interface-dm] and NSF Monitoring
Interface [I-D.ietf-i2nsf-nsf-monitoring-data-model] MUST be used
These provide a standardized ability to describe its to configure the use of a capability into an NSF and monitor the
functionality, and report its processing results, resepectively. NSF, respectively. These provide a standardized ability to
These facilitate multi-vendor interoperability. describe its functionality, and report its processing results,
respectively. These facilitate multi-vendor interoperability.
o Automation: The system MUST have the ability to auto-discover, * Automation: The system MUST have the ability to auto-discover,
auto-negotiate, and auto-update its security capabilities (i.e., auto-negotiate, and auto-update its security capabilities (i.e.,
without human intervention). These features are especially useful without human intervention). These features are especially useful
for the management of a large number of NSFs. They are essential for the management of a large number of NSFs. They are essential
for adding smart services (e.g., refinement, analysis, capability for adding smart services (e.g., refinement, analysis, capability
reasoning, and optimization) to the security scheme employed. reasoning, and optimization) to the security scheme employed.
These features are supported by many design patterns, including These features are supported by many design patterns, including
the Observer Pattern [OODOP], the Mediator Pattern [OODMP], and a the Observer Pattern [OODOP], the Mediator Pattern [OODMP], and a
set of Message Exchange Patterns [Hohpe]. set of Message Exchange Patterns [Hohpe]. Registration Interface
[I-D.ietf-i2nsf-registration-interface-dm] can register the
capabilities of NSFs with the security controller from the request
of Developer's Management System providing NSFs and the
corresponding security capabilities. Also, this interface can
send a query to Developer's Management System in order to find an
NSF to satisfy the requested security capability from the security
controller that receives a security policy.
o Scalability: The management system SHOULD have the capability to * Scalability: The management system SHOULD have the capability to
scale up/down or scale in/out. Thus, it can meet various scale up/down or scale in/out. Thus, it can meet various
performance requirements derived from changeable network traffic performance requirements derived from changeable network traffic
or service requests. In addition, security capabilities that are or service requests. In addition, security capabilities that are
affected by scalability changes SHOULD support reporting affected by scalability changes SHOULD support reporting
statistics to the security controller to assist its decision on statistics to the security controller to assist its decision on
whether it needs to invoke scaling or not. whether it needs to invoke scaling or not. NSF Monitoring
Interface [I-D.ietf-i2nsf-nsf-monitoring-data-model] can observe
the performance of NSFs to let the security controller decide
scalability changes of the NSFs.
Based on the above principles, this document defines a capability Based on the above principles, this document defines a capability
model that enables an NSF to register (and hence advertise) its set model that enables an NSF to register (and hence advertise) its set
of capabilities that other I2NSF Components can use. These of capabilities that other I2NSF Components can use. These
capabilities MAY have their access control restricted by a policy; capabilities MUST have their access control restricted by a policy;
this is out of scope for this document. The set of capabilities this is out of scope for this document. The set of capabilities
provided by a given set of NSFs unambiguously defines the security provided by a given set of NSFs unambiguously defines the security
services offered by the set of NSFs used. The security controller services offered by the set of NSFs used. The security controller
can compare the requirements of users and applications with the set can compare the requirements of users and applications with the set
of capabilities that are currently available in order to choose which of capabilities that are currently available in order to choose which
capabilities of which NSFs are needed to meet those requirements. capabilities of which NSFs are needed to meet those requirements.
Note that this choice is independent of vendor, and instead relies Note that this choice is independent of vendor, and instead relies
specifically on the capabilities (i.e., the description) of the specifically on the capabilities (i.e., the description) of the
functions provided. functions provided.
Furthermore, when an unknown threat (e.g., zero-day exploits and Furthermore, NSFs are subject to the updates of security capabilities
unknown malware) is reported by an NSF, new capabilities may be and software to cope with newly found security attacks or threats,
created, and/or existing capabilities may be updated (e.g., by hence new capabilities may be created, and/or existing capabilities
updating its signature and algorithm). This results in enhancing the may be updated (e.g., by updating its signature and algorithm). New
existing NSFs (and/or creating new NSFs) to address the new threats. capabilities may be sent to and stored in a centralized repository,
New capabilities may be sent to and stored in a centralized or stored separately in a vendor's local repository. In either case,
repository, or stored separately in a vendor's local repository. In Registration Interface can facilitate this update process to
either case, a standard interface facilitates this update process. Developer's Management System to let the security controller update
its repository for NSFs and their security capabilities.
The "Event-Condition-Action" (ECA) policy model in [RFC8329] is used The "Event-Condition-Action" (ECA) policy model in [RFC8329] is used
as the basis for the design of the capability model; definitions of as the basis for the design of the capability model; The following
all I2NSF policy-related terms are also defined in [RFC8329]. The three terms define the structure and behavior of an I2NSF imperative
following three terms define the structure and behavior of an I2NSF policy rule:
imperative policy rule:
o Event: An Event is defined as any important occurrence in time of * Event: An Event is defined as any important occurrence in time of
a change in the system being managed, and/or in the environment of a change in the system being managed, and/or in the environment of
the system being managed. When used in the context of I2NSF the system being managed. When used in the context of I2NSF
Policy Rules, it is used to determine whether the condition clause Policy Rules, it is used to determine whether the condition clause
of an I2NSF Policy Rule can be evaluated or not. Examples of an of an I2NSF Policy Rule can be evaluated or not. Examples of an
I2NSF Event include time and user actions (e.g., logon, logoff, I2NSF Event include time and user actions (e.g., logon, logoff,
and actions that violate an ACL). and actions that violate an ACL).
o Condition: A condition is defined as a set of attributes, * Condition: A condition is defined as a set of attributes,
features, and/or values that are to be compared with a set of features, and/or values that are to be compared with a set of
known attributes, features, and/or values in order to determine known attributes, features, and/or values in order to determine
whether or not the set of actions in that (imperative) I2NSF whether or not the set of actions in that (imperative) I2NSF
Policy Rule can be executed or not. Examples of I2NSF conditions Policy Rule can be executed or not. Examples of I2NSF conditions
include matching attributes of a packet or flow, and comparing the include matching attributes of a packet or flow, and comparing the
internal state of an NSF with a desired state. internal state of an NSF with a desired state.
o Action: An action is used to control and monitor aspects of flow- * Action: An action is used to control and monitor aspects of NSFs
based NSFs when the event and condition clauses are satisfied. to handle packets or flows when the event and condition clauses
NSFs provide security functions by executing various Actions. are satisfied. NSFs provide security functions by executing
Examples of I2NSF actions include providing intrusion detection various Actions. Examples of I2NSF actions include providing
and/or protection, web and flow filtering, and deep packet intrusion detection and/or protection, web and flow filtering, and
inspection for packets and flows. deep packet inspection for packets and flows.
An I2NSF Policy Rule is made up of three Boolean clauses: an Event An I2NSF Policy Rule is made up of three Boolean clauses: an Event
clause, a Condition clause, and an Action clause. This structure is clause, a Condition clause, and an Action clause. This structure is
also called an ECA (Event-Condition-Action) Policy Rule. A Boolean also called an ECA (Event-Condition-Action) Policy Rule. A Boolean
clause is a logical statement that evaluates to either TRUE or FALSE. clause is a logical statement that evaluates to either TRUE or FALSE.
It may be made up of one or more terms; if more than one term is It may be made up of one or more terms; if more than one term is
present, then each term in the Boolean clause is combined using present, then each term in the Boolean clause is combined using
logical connectives (i.e., AND, OR, and NOT). logical connectives (i.e., AND, OR, and NOT).
An I2NSF ECA Policy Rule has the following semantics: An I2NSF ECA Policy Rule has the following semantics:
skipping to change at page 8, line 17 skipping to change at page 8, line 40
contains three actions (A1, A2, and A3, in that order). Action A2 contains three actions (A1, A2, and A3, in that order). Action A2
has a priority of 10; actions A1 and A3 have no priority specified. has a priority of 10; actions A1 and A3 have no priority specified.
Then, metadata may be used to restrict the set of actions that can be Then, metadata may be used to restrict the set of actions that can be
executed when the event and condition clauses of this ECA Policy Rule executed when the event and condition clauses of this ECA Policy Rule
are evaluated to be TRUE; two examples are: (1) only the first action are evaluated to be TRUE; two examples are: (1) only the first action
(A1) is executed, and then the policy rule returns to its caller, or (A1) is executed, and then the policy rule returns to its caller, or
(2) all actions are executed, starting with the highest priority. (2) all actions are executed, starting with the highest priority.
The above ECA policy model is very general and easily extensible. The above ECA policy model is very general and easily extensible.
3.2. Matched Policy Rule 3.2. Conflict, Resolution Strategy and Default Action
The concept of a "matched" policy rule is defined as one in which its
event and condition clauses both evaluate to true. To precisely
describe what an NSF can do in terms of security, that a policy rule
needs to describe the events that it can catch, the conditions it can
evaluate, and the actions that it can enforce.
Therefore, the properties to characterize the capabilities of an NSF
are as follows:
o Ac is the set of Actions currently available from the NSF;
o Ec is the set of Events that an NSF can catch. Note that for NSF
(e.g., a packet filter) that are not able to react to events, this
set will be empty;
o Cc is the set of Conditions currently available from the NSF;
o EVc defines the set of Condition Clause Evaluation Rules that can
be used by the NSF to decide when the Condition Clause is true
when the results of the individual Conditions under evaluation are
given.
3.3. Conflict, Resolution Strategy and Default Action
Formally, two I2NSF Policy Rules conflict with each other if: Formally, two I2NSF Policy Rules conflict with each other if:
o the Event Clauses of each evaluate to TRUE; * the Event Clauses of each evaluate to TRUE;
o the Condition Clauses of each evaluate to TRUE; * the Condition Clauses of each evaluate to TRUE;
o the Action Clauses affect the same object in different ways. * the Action Clauses affect the same object in different ways.
For example, if we have two Policy Rules in the same Policy: For example, if we have two Policy Rules called R1 and R2 in the same
Policy:
R1: During 8am-6pm, if traffic is external, then run through FW R1: During 8am-6pm, if traffic is external, then run through
firewall
R2: During 7am-8pm, conduct anti-malware investigation R2: During 7am-8pm, run anti-virus
There is no conflict between R1 and R2, since the actions are There is no conflict between the two policy rules R1 and R2, since
different. However, consider these two rules: the actions are different. However, consider these two rules called
R3 and R4:
R3: During 8am-6pm, John gets GoldService R3: During 9am-6pm, allow John to access social networking service
websites
R4: During 10am-4pm, FTP from all users gets BronzeService R4: During 9am-6pm, disallow all users to access social networking
service websites
R3 and R4 are now in conflict, between the hours of 10am and 4pm, The two policy rules R3 and R4 are now in conflict, between the hours
because the actions of R3 and R4 are different and apply to the same of 9am and 6pm, because the actions of R3 and R4 are different and
user (i.e., John). apply to the same user (i.e., John).
Conflicts theoretically compromise the correct functioning of devices Conflicts theoretically compromise the correct functioning of
(as happened for routers several year ago). However, NSFs have been devices. However, NSFs have been designed to cope with these issues.
designed to cope with these issues. Since conflicts are originated Since conflicts are originated by simultaneously matching rules, an
by simultaneously matching rules, an additional process decides the additional process decides the action to be applied, e.g., among the
action to be applied, e.g., among the ones which the matching rule actions which the matching rule would have enforced. This process is
would have enforced. This process is described by means of a described by means of a resolution strategy for conflicts. The
resolution strategy for conflicts. finding and handling of conflicted matching rules is performed by
resolution strategies in the security controller. The implementation
of such resolution strategies is out of scope for I2NSF.
On the other hand, it may happen that, if an event is caught, none of On the other hand, it may happen that, if an event is caught, none of
the policy rules matches the event. As a simple case, no rules may the policy rules matches the condition. Note that a packet or flow
match a packet arriving at border firewall. In this case, the packet is handled only when it matches both the event and condition of a
is usually dropped, that is, the firewall has a default behavior to policy rule according to the ECA policy model. As a simple case, no
manage the cases that are not covered by specific rules. condition in the rules may match a packet arriving at the border
firewall. In this case, the packet is usually dropped, that is, the
firewall has a default behavior of packet dropping in order to manage
the cases that are not covered by specific rules.
Therefore, this document introduces another security capability that Therefore, this document introduces two further capabilities for an
serves to characterize valid policies for an NSF that solve conflicts NSF to handle security policy conflicts with resolution strategies
with resolution strategies and enforce default actions if no rules and enforce a default action if no rules match.
match:
o RSc is the set of Resolution Strategies that can be used to * Resolution Strategies: They can be used to specify how to resolve
specify how to resolve conflicts that occur between the actions of conflicts that occur between the actions of the same or different
the same or different policy rules that are matched and contained policy rules that are matched and contained in this particular
in this particular NSF; NSF;
o Dc defines the notion of a Default action. This action can be * Default Action: It provides the default behavior to be executed
either an explicit action or a set of actions. when there are no other alternatives. This action can be either
an explicit action or a set of actions.
4. Overview of YANG Data Model 4. Overview of YANG Data Model
This section provides an overview of how the YANG data model can be This section provides an overview of how the YANG data model can be
used in the I2NSF framework described in [RFC8329]. Figure 1 shows used in the I2NSF framework described in [RFC8329]. Figure 1 shows
the capabilities (e.g., firewall and web filter) of NSFs in the I2NSF the capabilities (e.g., firewall and web filter) of NSFs in the I2NSF
Framework. As shown in this figure, an NSF Developer's Management Framework. As shown in this figure, a Developer's Management System
System (DMS) can register NSFs and the capabilities that the NSFs can (DMS) can register NSFs and their capabilities with a Security
support. To register NSFs in this way, the DMS utilizes this Controller. To register NSFs in this way, the DMS utilizes the
standardized capability YANG data model through the I2NSF standardized capability YANG data model in this document through the
Registration Interface [RFC8329]. That is, this Registration I2NSF Registration Interface [RFC8329]. That is, this Registration
Interface uses the YANG module described in this document to describe Interface uses the YANG module described in this document to describe
the capabilities of an NSF that is registered with the Security the capabilities of an NSF that is registered with the Security
Controller. With the database of the capabilities of the NSFs that Controller. As described in [RFC8192], with the usage of
are maintained centrally, the NSFs can be more easily managed, which Registration Interface and the YANG module in this document, the NSFs
can resolve many of the problems described in [RFC8192]. manufactured by multiple vendors can be managed together by the
Security Controller in a centralized way and be updated dynamically
by each vendor as the NSF has software or hardware updates.
In Figure 1, a new NSF at a Developer's Management System has In Figure 1, a new NSF at a Developer's Management System has
capabilities of Firewall (FW) and Web Filter (WF), which are denoted capabilities of Firewall (FW) and Web Filter (WF), which are denoted
as (Cap = {FW, WF}), to support Event-Condition-Action (ECA) policy as (Cap = {FW, WF}), to support Event-Condition-Action (ECA) policy
rules where 'E', 'C', and 'A' mean "Event", "Condition", and rules where 'E', 'C', and 'A' mean "Event", "Condition", and
"Action", respectively. The condition involves IPv4 or IPv6 "Action", respectively. The condition involves IPv4 or IPv6
datagrams, and the action includes "Allow" and "Deny" for those datagrams, and the action includes "Allow" and "Deny" for those
datagrams. datagrams.
Note that the NSF-Facing Interface [RFC8329] is used for the Security Note that the NSF-Facing Interface [RFC8329] is used by the Security
Controller to configure the security policy rules of generic NSFs Controller to configure the security policy rules of NSFs (e.g.,
(e.g., firewall) and advanced NSFs (e.g., anti-virus and Distributed- firewall and Distributed-Denial-of-Service (DDoS) attack mitigator)
Denial-of-Service (DDoS) attack mitigator) with the capabilities of with the capabilities of the NSFs registered with the Security
the NSFs registered with the Security Controller. Controller.
+------------------------------------------------------+ +------------------------------------------------------+
| I2NSF User (e.g., Overlay Network Mgmt, Enterprise | | I2NSF User (e.g., Overlay Network Mgmt, Enterprise |
| Network Mgmt, another network domain's mgmt, etc.) | | Network Mgmt, another network domain's mgmt, etc.) |
+--------------------+---------------------------------+ +--------------------+---------------------------------+
I2NSF ^ I2NSF ^
Consumer-Facing Interface | Consumer-Facing Interface |
| |
v I2NSF v I2NSF
+-----------------+------------+ Registration +-------------+ +-----------------+------------+ Registration +-------------+
| Network Operator Mgmt System | Interface | Developer's | | Network Operator Mgmt System | Interface | Developer's |
| (i.e., Security Controller) |<-------------->| Mgmt System | | (i.e., Security Controller) |<------------->| Mgmt System |
+-----------------+------------+ +-------------+ +-----------------+------------+ +-------------+
^ New NSF ^ New NSF
| Cap = {FW, WF} | Cap = {FW, WF}
I2NSF | E = {} I2NSF | E = {}
NSF-Facing Interface | C = {IPv4, IPv6} NSF-Facing Interface | C = {IPv4, IPv6}
| A = {Allow, Deny} | A = {Allow, Deny}
v v
+---------------+----+------------+-----------------+ +---------------+----+------------+-----------------+
| | | | | | | |
+---+---+ +---+---+ +---+---+ +---+---+ +---+---+ +---+---+ +---+---+ +---+---+
| NSF-1 | ... | NSF-m | | NSF-1 | ... | NSF-n | | NSF-1 | ... | NSF-m | | NSF-1 | ... | NSF-n |
+-------+ +-------+ +-------+ +-------+ +-------+ +-------+ +-------+ +-------+
NSF-1 NSF-m NSF-1 NSF-n NSF-1 NSF-m NSF-1 NSF-n
Cap = {FW, WF} Cap = {FW, WF} Cap = {FW, WF} Cap = {FW, WF} Cap = {FW, WF} Cap = {FW, WF} Cap = {FW, WF} Cap = {FW, WF}
E = {} E = {user} E = {dev} E = {time} E = {} E = {user} E = {dev} E = {time}
C = {IPv4} C = {IPv6} C = {IPv4, IPv6} C = {IPv4} C = {IPv4} C = {IPv6} C = {IPv4, IPv6} C = {IPv4}
A = {Allow, Deny} A = {Allow, Deny} A = {Allow, Deny} A = {Allow, Deny} A = {Allow, Deny} A = {Allow, Deny} A = {Allow, Deny} A = {Allow, Deny}
Developer's Mgmt System A Developer's Mgmt System B Developer's Mgmt System A Developer's Mgmt System B
Figure 1: Capabilities of NSFs in I2NSF Framework Figure 1: Capabilities of NSFs in I2NSF Framework
A use case of an NSF with the capabilities of firewall and web filter A use case of an NSF with the capabilities of firewall and web filter
is described as follows. is described as follows.
o If a network administrator wants to apply security policy rules to * If a network administrator wants to apply security policy rules to
block malicious users with firewall and web filter, it is a block malicious users with firewall and web filter, it is a
tremendous burden for a network administrator to apply all of the tremendous burden for a network administrator to apply all of the
needed rules to NSFs one by one. This problem can be resolved by needed rules to NSFs one by one. This problem can be resolved by
managing the capabilities of NSFs as described in this document. managing the capabilities of NSFs as described in this document.
o If a network administrator wants to block IPv4 or IPv6 packets * If a network administrator wants to block IPv4 or IPv6 packets
from malicious users, the network administrator sends a security from malicious users, the network administrator sends a security
policy rule to block the users to the Network Operator Management policy rule to block the users to the Network Operator Management
System (i.e., Security Controller) using the I2NSF Consumer-Facing System (i.e., Security Controller) using the I2NSF Consumer-Facing
Interface. Interface.
o When the Network Operator Management System receives the security * When the Network Operator Management System receives the security
policy rule, it automatically sends that security policy rule to policy rule, it automatically sends that security policy rule to
appropriate NSFs (i.e., NSF-m in Developer's Management System A appropriate NSFs (i.e., NSF-m in Developer's Management System A
and NSF-1 in Developer's Management System B) which can support and NSF-1 in Developer's Management System B) which can support
the capabilities (i.e., IPv6). This lets an I2NSF User not the capabilities (i.e., IPv6). This lets an I2NSF User not
consider which specific NSF(s) will work for the security policy consider which specific NSF(s) will work for the security policy
rule. rule.
o If NSFs encounter the suspicious IPv4 or IPv6 packets of malicious * If NSFs encounter the suspicious IPv4 or IPv6 packets of malicious
users, they can filter the packets out according to the configured users, they can filter the packets out according to the configured
security policy rule. Therefore, the security policy rule against security policy rule. Therefore, the security policy rule against
the malicious users' packets can be automatically applied to the malicious users' packets can be automatically applied to
appropriate NSFs without human intervention. appropriate NSFs without human intervention.
5. YANG Tree Diagram 5. YANG Tree Diagram
This section shows a YANG tree diagram of capabilities of network This section shows a YANG tree diagram of capabilities of network
security functions, as defined in the Section 3. security functions, as defined in the Section 3.
skipping to change at page 13, line 7 skipping to change at page 13, line 7
features. Figure 2 shows a YANG tree diagram of NSF capabilities. features. Figure 2 shows a YANG tree diagram of NSF capabilities.
The NSF capabilities in the tree include time capabilities, event The NSF capabilities in the tree include time capabilities, event
capabilities, condition capabilities, action capabilities, resolution capabilities, condition capabilities, action capabilities, resolution
strategy capabilities, and default action capabilities. Those strategy capabilities, and default action capabilities. Those
capabilities can be tailored or extended according to a vendor's capabilities can be tailored or extended according to a vendor's
specific requirements. Refer to the NSF capabilities information specific requirements. Refer to the NSF capabilities information
model for detailed discussion in Section 3. model for detailed discussion in Section 3.
module: ietf-i2nsf-capability module: ietf-i2nsf-capability
+--rw nsf* [nsf-name] +--rw nsf* [nsf-name]
+--rw nsf-name string +--rw nsf-name string
+--rw time-capabilities* enumeration +--rw directional-capabilities* identityref
+--rw event-capabilities +--rw event-capabilities
| +--rw system-event-capability* identityref | +--rw system-event-capability* identityref
| +--rw system-alarm-capability* identityref | +--rw system-alarm-capability* identityref
| +--rw time-capabilities* identityref
+--rw condition-capabilities +--rw condition-capabilities
| +--rw generic-nsf-capabilities | +--rw generic-nsf-capabilities
| | +--rw ipv4-capability* identityref | | +--rw ipv4-capability* identityref
| | +--rw icmp-capability* identityref | | +--rw ipv6-capability* identityref
| | +--rw ipv6-capability* identityref | | +--rw icmpv4-capability* identityref
| | +--rw icmpv6-capability* identityref | | +--rw icmpv6-capability* identityref
| | +--rw tcp-capability* identityref | | +--rw tcp-capability* identityref
| | +--rw udp-capability* identityref | | +--rw udp-capability* identityref
| | +--rw sctp-capability* identityref | | +--rw sctp-capability* identityref
| | +--rw dccp-capability* identityref | | +--rw dccp-capability* identityref
| +--rw advanced-nsf-capabilities | +--rw advanced-nsf-capabilities
| | +--rw anti-virus-capability* identityref | | +--rw anti-ddos-capability* identityref
| | +--rw anti-ddos-capability* identityref | | +--rw ips-capability* identityref
| | +--rw ips-capability* identityref | | +--rw url-capability* identityref
| | +--rw url-capability* identityref | | +--rw voip-volte-filtering-capability* identityref
| | +--rw voip-volte-capability* identityref | +--rw context-capabilities
| +--rw context-capabilities* identityref | +--rw application-filter-capabilities* identityref
| +--rw target-capabilities* identityref
| +--rw user-condition-capabilities* identityref
| +--rw geography-capabilities* identityref
+--rw action-capabilities +--rw action-capabilities
| +--rw ingress-action-capability* identityref | +--rw ingress-action-capability* identityref
| +--rw egress-action-capability* identityref | +--rw egress-action-capability* identityref
| +--rw log-action-capability* identityref | +--rw log-action-capability* identityref
+--rw resolution-strategy-capabilities* identityref +--rw resolution-strategy-capabilities* identityref
+--rw default-action-capabilities* identityref +--rw default-action-capabilities* identityref
+--rw ipsec-method* identityref
Figure 2: YANG Tree Diagram of Capabilities of Network Security Figure 2: YANG Tree Diagram of Capabilities of Network Security
Functions Functions
Time capabilities are used to specify the capabilities which describe The data model in this document provides identities for the
when to execute the I2NSF policy rule. The time capabilities are capabilities of NSFs. Every identity in the data model represents
defined in terms of absolute time and periodic time. The absolute the capability of an NSF. Each identity is explained in the
time means the exact time to start or end. The periodic time means description of the identity.
repeated time like day, week, or month.
Event capabilities are used to specify the capabilities that describe Event capabilities are used to specify the capabilities that describe
an event that would trigger the evaluation of the condition clause of an event that would trigger the evaluation of the condition clause of
the I2NSF Policy Rule. The defined event capabilities are system the I2NSF Policy Rule. The defined event capabilities are system
event and system alarm. event, system alarm, and time. Time capabilities are used to specify
the capabilities which describe when to execute the I2NSF policy
rule. The time capabilities are defined in terms of absolute time
and periodic time. The absolute time means the exact time to start
or end. The periodic time means repeated time like day, week, month,
or year.
Condition capabilities are used to specify capabilities of a set of Condition capabilities are used to specify capabilities of a set of
attributes, features, and/or values that are to be compared with a attributes, features, and/or values that are to be compared with a
set of known attributes, features, and/or values in order to set of known attributes, features, and/or values in order to
determine whether a set of actions needs to be executed or not so determine whether a set of actions needs to be executed or not so
that an imperative I2NSF policy rule can be executed. In this that an imperative I2NSF policy rule can be executed. In this
document, two kinds of condition capabilities are used to classify document, two kinds of condition capabilities are used to classify
different capabilities of NSFs such as generic-nsf-capabilities for different capabilities of NSFs such as generic-nsf-capabilities and
generic NSFs and advanced-nsf-capabilities for advanced NSFs. First, advanced-nsf-capabilities. First, the generic-nsf-capabilities
the generic-nsf-capabilities define the common capabilities of NSFs define NSFs that operate on packet header for layer 2 (i.e., Ethernet
such as IPv4 capability, IPv6 capability, TCP capability, UDP capability), layer 3 (i.e., IPv4 capability, IPv6 capability, ICMPv4
capability, SCTP capability, DCCP capability, ICMP capability, and capability, and ICMPv6 capability.), and layer 4 (i.e., TCP
ICMPv6 capability. Second, the advanced-nsf-capabilities define capability, UDP capability, SCTP capability, and DCCP capability).
advanced capabilities of NSFs such as anti-virus capability, anti- Second, the advanced-nsf-capabilities define NSFs that operate on
DDoS capability, Intrusion Prevention System (IPS) capability, HTTP features different from the generic-nsf-capabilities, e.g., the
capability, and VoIP/VoLTE capability. Note that VoIP and VoLTE are payload, cross flow state, application layer, traffic statistics,
merged into a single capability in this document because VoIP and network behavior, etc. This document defines the advanced-nsf into
VoLTE use the Session Initiation Protocol (SIP) [RFC3261] for a call two categories such as content-security-control and attack-
setup. See Section 3.1 for more information about the condition in mitigation-control.
the ECA policy model.
* Content security control is an NSF that evaluates the payload of a
packet, such as Intrusion Prevention System (IPS), URL-Filtering,
Antivirus, and VoIP/VoLTE Filter.
* Attack mitigation control is an NSF that mitigates an attack such
as anti-DDoS (DDoS-mitigator).
The advanced-nsf can be extended with other types of NSFs. This
document only provides five advanced-nsf capabilities, i.e., IPS
capability, URL-Filtering capability, Antivirus capability, VoIP/
VoLTE Filter capability, and Anti-DDoS capability. Note that VoIP
and VoLTE are merged into a single capability in this document
because VoIP and VoLTE use the Session Initiation Protocol (SIP)
[RFC3261] for a call setup. See Section 3.1 for more information
about the condition in the ECA policy model.
The context capabilities provide extra information for the condition.
The given context conditions are application filter, target, user
condition, and geography location. The application filter capability
is capability in matching the packet based on the application
protocol, such as HTTP, HTTPS, FTP, etc. The target capability is
capability in matching the type of the target devices, such as PC,
IoT, Network Infrastructure devices, etc. The user condition is
capability in matching the users of the network by mapping each user
ID to an IP address. Users can be combined into one group. The
geography location capability is capability in matching the
geographical location of a source or destination of a packet.
Action capabilities are used to specify the capabilities that Action capabilities are used to specify the capabilities that
describe the control and monitoring aspects of flow-based NSFs when describe the control and monitoring aspects of flow-based NSFs when
the event and condition clauses are satisfied. The action the event and condition clauses are satisfied. The action
capabilities are defined as ingress-action capability, egress-action capabilities are defined as ingress-action capability, egress-action
capability, and log-action capability. See Section 3.1 for more capability, and log-action capability. See Section 3.1 for more
information about the action in the ECA policy model. Also, see information about the action in the ECA policy model. Also, see
Section 7.2 (NSF-Facing Flow Security Policy Structure) in [RFC8329] Section 7.2 (NSF-Facing Flow Security Policy Structure) in [RFC8329]
for more information about the ingress and egress actions. In for more information about the ingress and egress actions. In
addition, see Section 9.1 (Flow-Based NSF Capability addition, see Section 9.1 (Flow-Based NSF Capability
Characterization) in [RFC8329] and Section 7.5 (NSF Logs) in Characterization) in [RFC8329] and Section 7.5 (NSF Logs) in
[I-D.ietf-i2nsf-nsf-monitoring-data-model] for more information about [I-D.ietf-i2nsf-nsf-monitoring-data-model] for more information about
logging at NSFs. logging at NSFs.
Resolution strategy capabilities are used to specify the capabilities Resolution strategy capabilities are used to specify the capabilities
that describe conflicts that occur between the actions of the same or that describe conflicts that occur between the actions of the same or
different policy rules that are matched and contained in this different policy rules that are matched and contained in this
particular NSF. The resolution strategy capabilities are defined as particular NSF. The resolution strategy capabilities are defined as
First Matching Rule (FMR), Last Matching Rule (LMR), Prioritized First Matching Rule (FMR), Last Matching Rule (LMR), Prioritized
Matching Rule (PMR), Prioritized Matching Rule with Errors (PMRE), Matching Rule (PMR), Prioritized Matching Rule with Errors (PMRE),
and Prioritized Matching Rule with No Errors (PMRN). See Section 3.3 and Prioritized Matching Rule with No Errors (PMRN). See Section 3.2
for more information about the resolution strategy. for more information about the resolution strategy.
Default action capabilities are used to specify the capabilities that Default action capabilities are used to specify the capabilities that
describe how to execute I2NSF policy rules when no rule matches a describe how to execute I2NSF policy rules when no rule matches a
packet. The default action capabilities are defined as pass, drop, packet. The default action capabilities are defined as pass, drop,
alert, and mirror. See Section 3.3 for more information about the rate-limit, and mirror. See Section 3.2 for more information about
default action. the default action.
IPsec method capabilities are used to specify capabilities of how to
support an Internet Key Exchange (IKE) [RFC7296] for the security
communication. The default action capabilities are defined as IKE or
IKE-less. See [I-D.ietf-i2nsf-sdn-ipsec-flow-protection] for more
information about the SDN-based IPsec flow protection in I2NSF.
6. YANG Data Model of I2NSF NSF Capability 6. YANG Data Model of I2NSF NSF Capability
This section introduces a YANG module for NSFs' capabilities, as This section introduces a YANG module for NSFs' capabilities, as
defined in the Section 3. defined in the Section 3.
This YANG module imports from [RFC6991]. It makes references to It makes references to
o [RFC0768]
o [RFC0791]
o [RFC0792]
o [RFC0793]
o [RFC2474]
o [RFC3168]
o [RFC3261]
o [RFC4340]
o [RFC4443]
o [RFC4960]
o [RFC5595]
o [RFC6335]
o [RFC6437]
o [RFC6691]
o [RFC6864]
o [RFC7230]
o [RFC7231]
o [RFC7296]
o [RFC7323]
o [RFC8200]
o [RFC8329]
o [RFC8519]
o [RFC8805]
o [IANA-Protocol-Numbers]
o [I-D.ietf-tcpm-rfc793bis]
o [I-D.ietf-tcpm-accurate-ecn]
o [I-D.ietf-tsvwg-udp-options]
o [I-D.ietf-i2nsf-nsf-monitoring-data-model]
o [I-D.ietf-i2nsf-sdn-ipsec-flow-protection]
<CODE BEGINS> file "ietf-i2nsf-capability@2021-03-08.yang"
module ietf-i2nsf-capability {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability";
prefix
nsfcap;
organization
"IETF I2NSF (Interface to Network Security Functions)
Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/i2nsf>
WG List: <mailto:i2nsf@ietf.org>
Editor: Jaehoon Paul Jeong
<mailto:pauljeong@skku.edu>
Editor: Jinyong Tim Kim * [RFC0768]
<mailto:timkim@skku.edu>
Editor: Patrick Lingga * [RFC0791]
<mailto:patricklink@skku.edu>
Editor: Susan Hares * [RFC0792]
<mailto:shares@ndzh.com>";
description * [RFC0793]
"This module is a YANG module for I2NSF Network Security * [RFC2474]
Functions (NSFs)'s Capabilities.
Copyright (c) 2021 IETF Trust and the persons identified as * [RFC3168]
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or * [RFC3261]
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 * [RFC3501]
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
for full legal notices.";
// RFC Ed.: replace XXXX with an actual RFC number and remove * [RFC4340]
// this note.
revision "2021-03-08"{ * [RFC4443]
description "Initial revision.";
reference
"RFC XXXX: I2NSF Capability YANG Data Model";
// RFC Ed.: replace XXXX with an actual RFC number and remove * [RFC4960]
// this note.
}
/* * [RFC5595]
* Identities
*/
identity event { * [RFC6335]
description
"Base identity for I2NSF events.";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF NSF
Monitoring YANG Data Model - Event";
// RFC Ed.: replace the above draft with an actual RFC in the * [RFC6437]
// YANG module and remove this note.
}
identity system-event-capability { * [RFC6691]
base event;
description
"Identity for system event";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF NSF
Monitoring YANG Data Model - System event";
}
identity system-alarm-capability { * [RFC6864]
base event;
description
"Identity for system alarm";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF NSF
Monitoring YANG Data Model - System alarm";
}
identity access-violation { * [RFC7230]
base system-event-capability;
description
"Identity for access violation event";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF NSF
Monitoring YANG Data Model - System event for access
violation";
}
identity configuration-change { * [RFC7231]
base system-event-capability;
description
"Identity for configuration change event";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF NSF
Monitoring YANG Data Model - System event for configuration
change";
}
identity memory-alarm { * [RFC7296]
base system-alarm-capability;
description
"Identity for memory alarm. Alarm when memory usage
exceeds a threshold.";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF NSF
Monitoring YANG Data Model - System alarm for memory";
}
identity cpu-alarm { * [RFC7323]
base system-alarm-capability;
description
"Identity for CPU alarm. Alarm when CPU usage
exceeds a threshold.";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF NSF
Monitoring YANG Data Model - System alarm for CPU";
}
identity disk-alarm { * [RFC8200]
base system-alarm-capability;
description
"Identity for disk alarm. Alarm when disk usage
exceeds a threshold.";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF NSF
Monitoring YANG Data Model - System alarm for disk";
}
identity hardware-alarm { * [RFC8329]
base system-alarm-capability;
description
"Identity for hardware alarm. Alarm when a hardware failure
or hardware degradation occurs.";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF NSF
Monitoring YANG Data Model - System alarm for hardware";
}
identity interface-alarm { * [RFC8519]
base system-alarm-capability;
description
"Identity for interface alarm. Alarm when interface usage
exceeds a threshold.";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF NSF
Monitoring YANG Data Model - System alarm for interface";
}
identity condition { * [RFC8805]
description
"Base identity for I2NSF conditions";
}
identity context-capability { * [IANA-Protocol-Numbers]
base condition;
description
"Base identity for context condition capabilities for an NSF.
The context contains background information of various * [I-D.ietf-tcpm-rfc793bis]
entities such as an access control list, application layer
filter, target, user, group, and geography.";
}
identity access-control-list { * [I-D.ietf-tcpm-accurate-ecn]
base context-capability;
description
"Identity for Access Control List (ACL) condition capability";
reference
"RFC 8519: YANG Data Model for Network Access Control Lists
(ACLs) - A user-ordered set of rules used to configure the
forwarding behavior in an NSF.";
}
identity application-layer-filter { * [I-D.ietf-tsvwg-udp-options]
base context-capability; * [I-D.ietf-i2nsf-nsf-monitoring-data-model]
description
"Identity for application-layer-filter condition capability.
application-layer-filter capability can examine the contents
of a packet (e.g., a URL contained in an HTTP message).";
reference
"RFC7230: Hypertext Transfer Protocol (HTTP/1.1): Message
Syntax and Routing
RFC7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics
and Content";
}
identity target { <CODE BEGINS> file "ietf-i2nsf-capability@2021-08-14.yang"
base context-capability; module ietf-i2nsf-capability {
description yang-version 1.1;
"Identity for target condition capability"; namespace
reference "urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability";
"RFC 8519: YANG Data Model for Network Access Control Lists prefix
(ACLs) - An access control for a target (e.g., the nsfcap;
corresponding IP address) in an NSF.";
}
identity user { organization
base context-capability; "IETF I2NSF (Interface to Network Security Functions)
description Working Group";
"Identity for user condition capability.
A user (e.g., employee) can be mapped to an IP address of
a computing device (e.g., computer, laptop, and virtual
machine) which the user is using.";
reference
"RFC 8519: YANG Data Model for Network Access Control Lists
(ACLs) - An access control for a user (e.g., the
corresponding IP address) in an NSF.";
}
identity group { contact
base context-capability; "WG Web: <http://tools.ietf.org/wg/i2nsf>
description WG List: <mailto:i2nsf@ietf.org>
"Identity for group condition capability.
A group (e.g., employees) can be mapped to multiple IP
addresses of computing devices (e.g., computers, laptops,
and virtual machines) which the group is using.";
reference
"RFC 8519: YANG Data Model for Network Access Control Lists
(ACLs) - An access control for a group (e.g., the
corresponding IP addresses) in an NSF.";
}
identity geography { Editor: Jaehoon Paul Jeong
base context-capability; <mailto:pauljeong@skku.edu>
description
"Identity for geography condition capability";
reference
"RFC 8805: A Format for Self-Published IP Geolocation Feeds -
An access control for a geographical location (i.e.,
geolocation) that has the corresponding IP prefix.";
}
identity directional-capability { Editor: Jinyong Tim Kim
description <mailto:timkim@skku.edu>
"Base identity for directional traffic flow capability";
reference
"RFC 5101: Specification of the IP Flow Information
Export (IPFIX) Protocol for the Exchange of IP
Traffic Flow Information - Terminology Unidirectional
and Bidirectional Flow";
}
identity unidirectional { Editor: Patrick Lingga
base directional-capability; <mailto:patricklink@skku.edu>
description
"Identity for unirectional traffic flow.";
reference
"RFC 5101: Specification of the IP Flow Information
Export (IPFIX) Protocol for the Exchange of IP
Traffic Flow Information - Terminology Unidirectional
Flow";
}
identity bidirectional { Editor: Susan Hares
base directional-capability; <mailto:shares@ndzh.com>";
description
"Identity for bidirectional traffic flow.";
reference
"RFC 5101: Specification of the IP Flow Information
Export (IPFIX) Protocol for the Exchange of IP
Traffic Flow Information - Terminology Bidirectional
Flow";
}
identity ipv4-capability { description
base condition; "This module is a YANG module for I2NSF Network Security
description Functions (NSFs)'s Capabilities.
"Base identity for IPv4 condition capability";
reference
"RFC 791: Internet Protocol";
}
identity exact-ipv4-header-length { Copyright (c) 2021 IETF Trust and the persons identified as
base ipv4-capability; authors of the code. All rights reserved.
description
"Identity for exact-match IPv4 header-length
condition capability";
reference
"RFC 791: Internet Protocol - Header Length";
}
identity range-ipv4-header-length { Redistribution and use in source and binary forms, with or
base ipv4-capability; without modification, is permitted pursuant to, and subject to
description the license terms contained in, the Simplified BSD License set
"Identity for range-match IPv4 header-length forth in Section 4.c of the IETF Trust's Legal Provisions
condition capability"; Relating to IETF Documents
reference (https://trustee.ietf.org/license-info).
"RFC 791: Internet Protocol - Header Length";
}
identity ipv4-tos-dscp { This version of this YANG module is part of RFC XXXX
base ipv4-capability; (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
description for full legal notices.";
"Identity for IPv4 Type-Of-Service (TOS)
Differentiated Services Codepoint (DSCP)
condition capability";
reference
"RFC 791: Internet Protocol - Type of Service
RFC 2474: Definition of the Differentiated
Services Field (DS Field) in the IPv4 and
IPv6 Headers";
}
identity exact-ipv4-total-length {
base ipv4-capability;
description
"Identity for exact-match IPv4 total length
condition capability";
reference
"RFC 791: Internet Protocol - Total Length";
}
identity range-ipv4-total-length { // RFC Ed.: replace XXXX with an actual RFC number and remove
base ipv4-capability; // this note.
description
"Identity for range-match IPv4 total length
condition capability";
reference
"RFC 791: Internet Protocol - Total Length";
}
identity ipv4-id { revision "2021-08-14"{
base ipv4-capability; description "Initial revision.";
description reference
"Identity for IPv4 identification condition capability. "RFC XXXX: I2NSF Capability YANG Data Model";
IPv4 ID field is used for fragmentation and reassembly.";
reference
"RFC 791: Internet Protocol - Identification
RFC 6864: Updated Specification of the IPv4 ID Field -
Fragmentation and Reassembly";
}
identity ipv4-fragment-flags { // RFC Ed.: replace XXXX with an actual RFC number and remove
base ipv4-capability; // this note.
description }
"Identity for IPv4 fragment flags condition capability";
reference
"RFC 791: Internet Protocol - Fragmentation Flags";
}
identity exact-ipv4-fragment-offset { /*
base ipv4-capability; * Identities
description */
"Identity for exact-match IPv4 fragment offset
condition capability";
reference
"RFC 791: Internet Protocol - Fragmentation Offset";
}
identity range-ipv4-fragment-offset { identity event {
base ipv4-capability; description
description "Base identity for I2NSF events.";
"Identity for range-match IPv4 fragment offset reference
condition capability"; "draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF NSF
reference Monitoring YANG Data Model - Event";
"RFC 791: Internet Protocol - Fragmentation Offset"; }
}
identity exact-ipv4-ttl { identity system-event {
base ipv4-capability; base event;
description description
"Identity for exact-match IPv4 Time-To-Live (TTL) "Identity for system event";
condition capability"; reference
reference "draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF NSF
"RFC 791: Internet Protocol - Time To Live (TTL)"; Monitoring YANG Data Model - System event";
} }
identity range-ipv4-ttl { identity system-alarm {
base ipv4-capability; base event;
description description
"Identity for range-match IPv4 Time-To-Live (TTL) "Identity for system alarm";
condition capability"; reference
reference "draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF NSF
"RFC 791: Internet Protocol - Time To Live (TTL)"; Monitoring YANG Data Model - System alarm";
} }
identity ipv4-protocol { identity time {
base ipv4-capability; base event;
description description
"Identity for IPv4 protocol condition capability"; "Identity for time capabilities";
reference }
"IANA Website: Assigned Internet Protocol Numbers identity access-violation {
- Protocol Number for IPv4 base system-event;
RFC 791: Internet Protocol - Protocol"; description
} "Identity for access violation event";
reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF NSF
Monitoring YANG Data Model - System event for access
violation";
}
identity prefix-ipv4-address-flow-direction { identity configuration-change {
base ipv4-capability; base system-event;
description description
"Identity for flow direction of prefix-match IPv4 source "Identity for configuration change event";
or destination address(es) condition capability where flow reference
direction is either unidirectional or bidirectional"; "draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF NSF
reference Monitoring YANG Data Model - System event for configuration
"RFC 4340: Datagram Congestion Control Protocol"; change";
} }
identity prefix-ipv4-address { identity memory-alarm {
base ipv4-capability; base system-alarm;
description description
"Identity for prefix-match IPv4 source or destination "Identity for memory alarm. Alarm when memory usage
address condition capability. The addresses are specified exceeds a threshold.";
by a pair of prefix and prefix length."; reference
reference "draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF NSF
"RFC 791: Internet Protocol - Address"; Monitoring YANG Data Model - System alarm for memory";
} }
identity prefix-ipv4-src-address { identity cpu-alarm {
base ipv4-capability; base system-alarm;
description description
"Identity for prefix-match IPv4 source address condition "Identity for CPU alarm. Alarm when CPU usage
capability. The addresses are specified by a pair of exceeds a threshold.";
prefix and prefix length."; reference
reference "draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF NSF
"RFC 791: Internet Protocol - Address"; Monitoring YANG Data Model - System alarm for CPU";
} }
identity prefix-ipv4-dst-address { identity disk-alarm {
base ipv4-capability; base system-alarm;
description description
"Identity for prefix-match IPv4 destination address "Identity for disk alarm. Alarm when disk usage
condition capability. The addresses are specified by a exceeds a threshold.";
pair of prefix and prefix length."; reference
reference "draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF NSF
"RFC 791: Internet Protocol - Address"; Monitoring YANG Data Model - System alarm for disk";
}
identity range-ipv4-address-flow-direction { }
base ipv4-capability;
description
"Identity for flow direction of range-match IPv4 source
or destination address(es) condition capability where flow
direction is either unidirectional or bidirectional";
reference
"RFC 4340: Datagram Congestion Control Protocol";
}
identity range-ipv4-address { identity hardware-alarm {
base ipv4-capability; base system-alarm;
description description
"Identity for range-match IPv4 source or destination "Identity for hardware alarm. Alarm when a hardware failure
address condition capability. The addresses are specified or hardware degradation occurs.";
by a pair of a start address and an end address."; reference
reference "draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF NSF
"RFC 791: Internet Protocol - Address"; Monitoring YANG Data Model - System alarm for hardware";
} }
identity range-ipv4-src-address { identity interface-alarm {
base ipv4-capability; base system-alarm;
description description
"Identity for range-match IPv4 source address condition "Identity for interface alarm. Alarm when interface usage
capability. The addresses are specified by a pair of exceeds a threshold.";
by a start address and an end address."; reference
"draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF NSF
Monitoring YANG Data Model - System alarm for interface";
}
reference identity absolute-time {
"RFC 791: Internet Protocol - Address"; base time;
} description
"absolute time capabilities.
If a network security function has the absolute time
capability, the network security function supports
rule execution according to absolute time.";
}
identity range-ipv4-dst-address { identity periodic-time {
base ipv4-capability; base time;
description description
"Identity for range-match IPv4 destination address "periodic time capabilities.
condition capability. The addresses are specified by If a network security function has the periodic time
a pair of by a start address and an end address."; capability, the network security function supports
reference rule execution according to periodic time.";
"RFC 791: Internet Protocol - Address"; }
}
identity ipv4-ip-opts { identity target-device {
base ipv4-capability; description
description "Identity for target condition capability. The capability for
"Identity for IPv4 option condition capability"; matching the target device type.";
reference }
"RFC 791: Internet Protocol - Options";
}
identity ipv4-geo-ip { identity computer {
base ipv4-capability; base target-device;
description description
"Identity for IPv4 geography condition capability"; "Identity for computer such as personal computer (PC)
reference and server";
"RFC 8805: Self-published IP Geolocation Data - An }
access control for a geographical location i.e.,
geolocation (e.g., the corresponding IP address).";
}
identity ipv6-capability { identity mobile-phone {
base condition; base target-device;
description description
"Base identity for IPv6 condition capabilities"; "Identity for mobile-phone such as smartphone and
reference cellphone";
"RFC 8200: Internet Protocol, Version 6 (IPv6) }
Specification";
}
identity ipv6-traffic-class-dscp { identity voip-volte-phone {
base ipv6-capability; base target-device;
description description
"Identity for IPv6 traffic classes "Identity for voip-volte-phone";
Differentiated Services Codepoint (DSCP) }
condition capability";
reference
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Traffic Class
RFC 2474: Definition of the Differentiated
Services Field (DS Field) in the IPv4 and
IPv6 Headers.";
}
identity exact-ipv6-flow-label { identity tablet {
base ipv6-capability; base target-device;
description description
"Identity for exact-match IPv6 flow label "Identity for tablet";
condition capability"; }
reference
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Flow Label
RFC 6437: IPv6 Flow Label Specification";
}
identity range-ipv6-flow-label { identity network-infrastructure-device {
base ipv6-capability; base target-device;
description description
"Identity for range-match IPv6 flow label "Identity for network infrastructure devices
condition capability"; such as switch, router, and access point";
reference }
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Flow Label
RFC 6437: IPv6 Flow Label Specification";
}
identity exact-ipv6-payload-length { identity iot {
base ipv6-capability; base target-device;
description description
"Identity for exact-match IPv6 payload length "Identity for IoT (Internet of Things)";
condition capability"; }
reference
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Payload Length";
}
identity range-ipv6-payload-length { identity ot {
base ipv6-capability; base target-device;
description description
"Identity for range-match IPv6 payload length "Identity for Operational Technology";
condition capability"; }
reference
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Payload Length";
}
identity ipv6-next-header { identity vehicle {
base ipv6-capability; base target-device;
description description
"Identity for IPv6 next header condition capability"; "Identity for vehicle that connects to and shares
reference data through the Internet";
"IANA Website: Assigned Internet Protocol Numbers
- Protocol Number for IPv6
RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Next Header";
}
identity exact-ipv6-hop-limit { }
base ipv6-capability;
description
"Identity for exact-match IPv6 hop limit condition
capability";
reference
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Hop Limit";
}
identity range-ipv6-hop-limit { identity user-condition {
base ipv6-capability; description
description "Base identity for user condition capability. This is the
"Identity for range-match IPv6 hop limit condition capability of mapping user(s) into their corresponding IP
capability"; address";
reference }
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Hop Limit";
}
identity prefix-ipv6-address-flow-direction { identity user {
base ipv6-capability; base user-condition;
description description
"Identity for flow direction of prefix-match IPv6 source "Identity for user condition capability.
or destination address(es) condition capability where flow A user (e.g., employee) can be mapped to an IP address of
direction is either unidirectional or bidirectional"; a computing device (e.g., computer, laptop, and virtual
reference machine) which the user is using.";
"RFC 8200: Internet Protocol, Version 6 (IPv6) }
Specification - Address";
}
identity prefix-ipv6-address {
base ipv6-capability;
description
"Identity for prefix-match IPv6 address condition
capability. The addresses are specified by a pair
of prefix and prefix length.";
reference
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Address";
}
identity prefix-ipv6-src-address { identity group {
base ipv6-capability; base user-condition;
description description
"Identity for prefix-match IPv6 source address condition "Identity for group condition capability.
capability. The addresses are specified by a pair of A group (e.g., employees) can be mapped to multiple IP
prefix and prefix length."; addresses of computing devices (e.g., computers, laptops,
reference and virtual machines) which the group is using.";
"RFC 8200: Internet Protocol, Version 6 (IPv6) }
Specification - Address";
}
identity prefix-ipv6-dst-address { identity geography-location {
base ipv6-capability; description
description "Identity for geography condition capability";
"Identity for prefix-match IPv6 destination address reference
condition capability. The addresses are specified by a "RFC 8805: A Format for Self-Published IP Geolocation Feeds -
pair of prefix and prefix length."; An access control for a geographical location (i.e.,
reference geolocation) that has the corresponding IP prefix.";
"RFC 8200: Internet Protocol, Version 6 (IPv6) }
Specification - Address";
}
identity range-ipv6-address-flow-direction { identity source-location {
base ipv6-capability; base geography-location;
description description
"Identity for flow direction of prefix-match IPv6 source "Identity for source geography location condition capability";
or destination address(es) condition capability where flow reference
direction is either unidirectional or bidirectional"; "RFC 8805: A Format for Self-Published IP Geolocation Feeds -
reference An access control for a geographical location (i.e.,
"RFC 8200: Internet Protocol, Version 6 (IPv6) geolocation) that has the corresponding IP prefix.";
Specification - Address"; }
}
identity range-ipv6-address { identity destination-location {
base ipv6-capability; base geography-location;
description description
"Identity for range-match IPv6 source or destination "Identity for destination geography location condition
address condition capability. The addresses are capability";
specified by a pair of a start address and an end reference
address."; "RFC 8805: A Format for Self-Published IP Geolocation Feeds -
reference An access control for a geographical location (i.e.,
"RFC 8200: Internet Protocol, Version 6 (IPv6) geolocation) that has the corresponding IP prefix.";
Specification - Address"; }
}
identity range-ipv6-src-address { identity directional {
base ipv6-capability; description
description "Base identity for directional traffic flow capability";
"Identity for range-match IPv6 source address reference
condition capability. The addresses are specified "RFC 5101: Specification of the IP Flow Information
by a pair of a start address and an end address."; Export (IPFIX) Protocol for the Exchange of IP
reference Traffic Flow Information - Terminology Unidirectional
"RFC 8200: Internet Protocol, Version 6 (IPv6) and Bidirectional Flow";
Specification - Address"; }
}
identity range-ipv6-dst-address { identity unidirectional {
base ipv6-capability; base directional;
description description
"Identity for range-match IPv6 destination address "Identity for unirectional traffic flow.";
condition capability. The addresses are specified reference
by a pair of a start address and an end address."; "RFC 5101: Specification of the IP Flow Information
reference Export (IPFIX) Protocol for the Exchange of IP
"RFC 8200: Internet Protocol, Version 6 (IPv6) Traffic Flow Information - Terminology Unidirectional
Specification - Address"; Flow";
} }
identity ipv6-header-order { identity bidirectional {
base ipv6-capability; base directional;
description description
"Identity for IPv6 extension header order condition "Identity for bidirectional traffic flow.";
capability"; reference
reference "RFC 5101: Specification of the IP Flow Information
"RFC 8200: Internet Protocol, Version 6 (IPv6) Export (IPFIX) Protocol for the Exchange of IP
Specification - Extension Header Order"; Traffic Flow Information - Terminology Bidirectional
} Flow";
}
identity ipv6-options { identity protocol {
base ipv6-capability; description
description "Base identity for Internet Protocols";
"Identity for IPv6 options type condition }
capability";
reference
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Options";
} identity ethernet {
base protocol;
description
"Base identity for data link layer protocol.";
}
identity ipv6-hop-by-hop { identity source-mac-address {
base ipv6-capability; base ethernet;
description description
"Identity for IPv6 hop by hop options header "Identity for the capability of matching Media Access Control
condition capability"; (MAC) source address(es) condition capability.";
reference reference
"RFC 8200: Internet Protocol, Version 6 (IPv6) "IEEE 802.3: IEEE Standard for Ethernet";
Specification - Options"; }
}
identity ipv6-routing-header { identity destination-mac-address {
base ipv6-capability; base ethernet;
description description
"Identity for IPv6 routing header condition "Identity for the capability of matching Media Access Control
capability"; (MAC) destination address(es) condition capability.";
reference reference
"RFC 8200: Internet Protocol, Version 6 (IPv6) "IEEE 802.3: IEEE Standard for Ethernet";
Specification - Routing Header"; }
}
identity ipv6-fragment-header { identity ether-type {
base ipv6-capability; base ethernet;
description description
"Identity for IPv6 fragment header condition "Identity for the capability of matching the EtherType of a
capability"; packet.";
reference reference
"RFC 8200: Internet Protocol, Version 6 (IPv6) "IEEE 802.3: IEEE Standard for Ethernet";
Specification - Fragment Header"; }
}
identity ipv6-destination-options { identity ip {
base ipv6-capability; base protocol;
description description
"Identity for IPv6 destination options condition "Base identity for internet/network layer protocol,
capability"; e.g., IPv4, IPv6, and ICMP.";
reference }
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Destination Options";
}
identity ipv6-geo-ip { identity ipv4 {
base ipv6-capability; base ip;
description description
"Identity for IPv4 geography condition capability"; "Base identity for IPv4 condition capability";
reference reference
"RFC 8805: Self-published IP Geolocation Data - An "RFC 791: Internet Protocol";
access control for a geographical location i.e., }
geolocation (e.g., the corresponding IP address).";
}
identity tcp-capability { identity ipv6 {
base condition; base ip;
description description
"Base identity for TCP condition capabilities"; "Base identity for IPv6 condition capabilities";
reference reference
"RFC 793: Transmission Control Protocol "RFC 8200: Internet Protocol, Version 6 (IPv6)
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol Specification";
(TCP) Specification"; }
}
identity exact-tcp-port-num-flow-direction { identity dscp {
base tcp-capability; base ipv4;
description base ipv6;
"Identity for flow direction of exact-match TCP source or description
destination port number condition capability where flow "Identity for the capability of matching IPv4 annd IPv6
direction is either unidirectional or bidirectional"; Differentiated Services Codepoint (DSCP) condition";
reference reference
"RFC 793: Transmission Control Protocol - Port Number "RFC 791: Internet Protocol - Type of Service
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol RFC 2474: Definition of the Differentiated
(TCP) Specification"; Services Field (DS Field) in the IPv4 and
} IPv6 Headers
RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Traffic Class";
}
identity exact-tcp-port-num { identity length {
base tcp-capability; base ipv4;
description base ipv6;
"Identity for exact-match TCP source or destination port description
number condition capability"; "Identity for the capability of matching IPv4 Total Length header
reference field or IPv6 Payload Length header field.
"RFC 793: Transmission Control Protocol - Port Number
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol
(TCP) Specification";
}
identity exact-tcp-src-port-num { IPv4 Total Length is the length of datagram, measured in octets,
base tcp-capability; including internet header and data.
description
"Identity for exact-match TCP source port
number condition capability";
reference
"RFC 793: Transmission Control Protocol - Port Number
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol
(TCP) Specification";
}
identity exact-tcp-dst-port-num {
base tcp-capability;
description
"Identity for exact-match TCP destination port
number condition capability";
reference
"RFC 793: Transmission Control Protocol - Port Number
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol
(TCP) Specification";
}
identity range-tcp-port-num-flow-direction { IPv6 Payload Length is the length of the IPv6 payload, i.e., the
base tcp-capability; rest of the packet following the IPv6 header, measured in
description octets.";
"Identity for flow direction of range-match TCP source or reference
destination port number condition capability where flow "RFC 791: Internet Protocol - Total Length
direction is either unidirectional or bidirectional"; RFC 8200: Internet Protocol, Version 6 (IPv6)
reference Specification - Payload Length";
"RFC 793: Transmission Control Protocol - Port Number }
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol
(TCP) Specification";
}
identity range-tcp-port-num { identity ttl {
base tcp-capability; base ipv4;
description base ipv6;
"Identity for range-match TCP source or destination port description
number condition capability. The port numbers are "Identity for the capability of matching IPv4 Time-To-Live (TTL)
specified by a pair of a start port number and an end or IPv6 Hop Limit.";
port number.";
reference reference
"RFC 793: Transmission Control Protocol - Port Number "RFC 791: Internet Protocol - Time To Live (TTL)
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol RFC 8200: Internet Protocol, Version 6 (IPv6)
(TCP) Specification"; Specification - Hop Limit";
} }
identity range-tcp-src-port-num { identity next-header {
base tcp-capability; base ipv4;
description base ipv6;
"Identity for range-match TCP source port number description
condition capability. The port numbers are specified by "Identity for the capability of matching IPv4 Protocol Field or
a pair of a start port number and an end port number."; equivalent to IPv6 Next Header.";
reference reference
"RFC 793: Transmission Control Protocol - Port Number "IANA Website: Assigned Internet Protocol Numbers
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol - Protocol Number for IPv4
(TCP) Specification"; RFC 791: Internet Protocol - Protocol
} RFC 8200: Internet Protocol, Version 6 (IPv6)
identity range-tcp-dst-port-num { Specification - Next Header";
base tcp-capability; }
description
"Identity for range-match TCP destination port number
condition capability. The port numbers are specified by
a pair of a start port number and an end port number.";
reference
"RFC 793: Transmission Control Protocol - Port Number
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol
(TCP) Specification";
}
identity tcp-flags { identity source-address {
base tcp-capability; base ipv4;
description base ipv6;
"Identity for TCP control bits (flags) condition capability"; description
reference "Identity for the capability of matching IPv4 or IPv6 source
"RFC 793: Transmission Control Protocol - Flags address(es) condition capability.";
RFC 3168: The Addition of Explicit Congestion Notification reference
(ECN) to IP - TCP Header Flags "RFC 791: Internet Protocol - Address
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol RFC 8200: Internet Protocol, Version 6 (IPv6)
(TCP) Specification Specification - Source Address";
draft-ietf-tcpm-accurate-ecn: More Accurate ECN Feedback }
in TCP";
}
identity tcp-options { identity destination-address {
base tcp-capability; base ipv4;
description base ipv6;
"Identity for TCP options condition capability"; description
reference "Identity for the capability of matching IPv4 or IPv6 destination
"RFC 793: Transmission Control Protocol - Options address(es) condition capability.";
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol reference
(TCP) Specification "RFC 791: Internet Protocol - Address
RFC 6691: TCP Options and Maximum Segment Size RFC 8200: Internet Protocol, Version 6 (IPv6)
RFC 7323: TCP Extensions for High Performance"; Specification - Destination Address";
} }
identity udp-capability { identity flow-direction {
base condition; base ipv4;
description base ipv6;
"Base identity for UDP condition capabilities"; description
reference "Identity for flow direction of matching IPv4/IPv6 source
"RFC 768: User Datagram Protocol"; or destination address(es) condition capability where a flow's
} direction is either unidirectional or bidirectional";
reference
"RFC 791: Internet Protocol
RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification";
}
identity exact-udp-port-num-flow-direction { identity header-length {
base udp-capability; base ipv4;
description description
"Identity for flow direction of exact-match UDP source or "Identity for matching IPv4 header-length
destination port number condition capability where flow condition capability";
direction is either unidirectional or bidirectional"; reference
reference "RFC 791: Internet Protocol - Header Length";
"RFC 768: User Datagram Protocol - Port Number"; }
}
identity exact-udp-port-num { identity identification {
base udp-capability; base ipv4;
description description
"Identity for exact-match UDP source or destination "Identity for IPv4 identification condition capability.
port number condition capability"; IPv4 ID field is used for fragmentation and reassembly.";
reference reference
"RFC 768: User Datagram Protocol - Port Number"; "RFC 791: Internet Protocol - Identification
} RFC 6864: Updated Specification of the IPv4 ID Field -
Fragmentation and Reassembly";
}
identity exact-udp-src-port-num { identity fragment-flags {
base udp-capability; base ipv4;
description description
"Identity for exact-match UDP source port number "Identity for IPv4 fragment flags condition capability";
condition capability"; reference
reference "RFC 791: Internet Protocol - Fragmentation Flags";
"RFC 768: User Datagram Protocol - Port Number"; }
}
identity exact-udp-dst-port-num { identity fragment-offset {
base udp-capability; base ipv4;
description description
"Identity for exact-match UDP destination port number "Identity for matching IPv4 fragment offset
condition capability"; condition capability";
reference reference
"RFC 768: User Datagram Protocol - Port Number"; "RFC 791: Internet Protocol - Fragmentation Offset";
} }
identity range-udp-port-num-flow-direction { identity ipv4-options {
base udp-capability; base ipv4;
description description
"Identity for flow direction of range-match UDP source or "Identity for IPv4 options condition capability";
destination port number condition capability where flow reference
direction is either unidirectional or bidirectional"; "RFC 791: Internet Protocol - Options";
reference }
"RFC 768: User Datagram Protocol - Port Number";
}
identity range-udp-port-num { identity flow-label {
base udp-capability; base ipv6;
description description
"Identity for range-match UDP source or destination "Identity for matching IPv6 flow label
port number condition capability. The port numbers condition capability";
are specified by a pair of a start port number and reference
an end port number."; "RFC 8200: Internet Protocol, Version 6 (IPv6)
reference Specification - Flow Label
"RFC 768: User Datagram Protocol - Port Number"; RFC 6437: IPv6 Flow Label Specification";
} }
identity range-udp-src-port-num { identity header-order {
base udp-capability; base ipv6;
description description
"Identity for range-match UDP source port number "Identity for IPv6 extension header order condition
condition capability. The port numbers are specified by capability";
a pair of a start port number and an end port number."; reference
reference "RFC 8200: Internet Protocol, Version 6 (IPv6)
"RFC 768: User Datagram Protocol - Port Number"; Specification - Extension Header Order";
} }
identity range-udp-dst-port-num { identity hop-by-hop {
base udp-capability; base ipv6;
description description
"Identity for range-match TCP destination port number "Identity for IPv6 hop by hop options header
condition capability. The port numbers are specified by condition capability";
a pair of a start port number and an end port number."; reference
reference "RFC 8200: Internet Protocol, Version 6 (IPv6)
"RFC 768: User Datagram Protocol - Port Number";
}
identity exact-udp-total-length { Specification - Options";
base udp-capability; }
description
"Identity for exact-match UDP total-length condition capability.
The UDP total length can be smaller than the IP transport
length for UDP transport layer options.";
reference
"RFC 768: User Datagram Protocol - Total Length
draft-ietf-tsvwg-udp-options: Transport Options for UDP";
}
identity range-udp-total-length { identity routing-header {
base udp-capability; base ipv6;
description description
"Identity for range-match UDP total-length condition capability. "Identity for IPv6 routing header condition
The UDP total length can be smaller than the IP transport capability";
length for UDP transport layer options."; reference
reference "RFC 8200: Internet Protocol, Version 6 (IPv6)
"RFC 768: User Datagram Protocol - Total Length Specification - Routing Header";
draft-ietf-tsvwg-udp-options: Transport Options for UDP"; }
identity fragment-header {
base ipv6;
description
"Identity for IPv6 fragment header condition
capability";
reference
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Fragment Header";
}
} identity destination-options {
base ipv6;
description
"Identity for IPv6 destination options condition
capability";
reference
"RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - Destination Options";
}
identity sctp-capability { identity icmp {
description base protocol;
"Identity for SCTP condition capabilities"; description
reference "Base identity for ICMPv4 and ICMPv6 condition capability";
"RFC 4960: Stream Control Transmission Protocol"; reference
} "RFC 792: Internet Control Message Protocol
RFC 4443: Internet Control Message Protocol (ICMPv6)
for the Internet Protocol Version 6 (IPv6) Specification
- ICMPv6";
}
identity exact-sctp-port-num-flow-direction { identity icmpv4 {
base sctp-capability; base icmp;
description description
"Identity for flow direction of range-match SCTP source or "Base identity for ICMPv4 condition capability";
destination port number condition capability where flow reference
direction is either unidirectional or bidirectional"; "RFC 792: Internet Control Message Protocol";
reference }
"RFC 4960: Stream Control Transmission Protocol - Port Number";
}
identity exact-sctp-port-num { identity icmpv6 {
base sctp-capability; base icmp;
description description
"Identity for exact-match SCTP source or destination "Base identity for ICMPv6 condition capability";
port number condition capability"; reference
reference "RFC 4443: Internet Control Message Protocol (ICMPv6)
"RFC 4960: Stream Control Transmission Protocol - Port Number"; for the Internet Protocol Version 6 (IPv6) Specification
} - ICMPv6";
}
identity type {
base icmpv4;
base icmpv6;
description
"Identity for ICMPv4 and ICMPv6 type condition capability";
reference
"RFC 792: Internet Control Message Protocol
RFC 4443: Internet Control Message Protocol (ICMPv6)
for the Internet Protocol Version 6 (IPv6) Specification
- ICMPv6";
}
identity exact-sctp-src-port-num { identity code {
base sctp-capability; base icmpv4;
description base icmpv6;
"Identity for exact-match SCTP source port number description
condition capability"; "Identity for ICMPv4 and ICMPv6 code condition capability";
reference reference
"RFC 4960: Stream Control Transmission Protocol - Port Number"; "RFC 792: Internet Control Message Protocol
} RFC 4443: Internet Control Message Protocol (ICMPv6)
for the Internet Protocol Version 6 (IPv6) Specification
- ICMPv6";
}
identity exact-sctp-dst-port-num { identity transport-protocol {
base sctp-capability; base protocol;
description description
"Identity for exact-match SCTP destination port number "Base identity for Layer 4 protocol condition capabilities, e.g.,
condition capability"; TCP, UDP, SCTP, DCCP, and ICMP";
reference }
"RFC 4960: Stream Control Transmission Protocol - Port Number";
}
identity range-sctp-port-num-flow-direction { identity tcp {
base sctp-capability; base transport-protocol;
description description
"Identity for flow direction of range-match SCTP source or "Base identity for TCP condition capabilities";
destination port number condition capability where flow reference
direction is either unidirectional or bidirectional"; "RFC 793: Transmission Control Protocol
reference draft-ietf-tcpm-rfc793bis: Transmission Control Protocol
"RFC 4960: Stream Control Transmission Protocol - Port Number"; (TCP) Specification";
} }
identity range-sctp-port-num { identity udp {
base sctp-capability; base transport-protocol;
description description
"Identity for range-match SCTP source or destination "Base identity for UDP condition capabilities";
port number condition capability. The port numbers are reference
specified by a pair of a start port number and an end "RFC 768: User Datagram Protocol";
port number."; }
reference identity sctp {
"RFC 4960: Stream Control Transmission Protocol - Port Number"; base transport-protocol;
} description
"Identity for SCTP condition capabilities";
reference
"RFC 4960: Stream Control Transmission Protocol";
}
identity range-sctp-src-port-num { identity dccp {
base sctp-capability; base transport-protocol;
description description
"Identity for range-match SCTP source port number "Identity for DCCP condition capabilities";
condition capability. The port numbers are specified by reference
a pair of a start port number and an end port number."; "RFC 4340: Datagram Congestion Control Protocol";
reference }
"RFC 4960: Stream Control Transmission Protocol - Port Number";
}
identity range-sctp-dst-port-num { identity source-port-number {
base sctp-capability; base tcp;
description base udp;
"Identity for range-match SCTP destination port number base sctp;
condition capability. The port numbers are specified by base dccp;
a pair of a start port number and an end port number."; description
reference "Identity for matching TCP, UDP, SCTP, and DCCP source port
"RFC 4960: Stream Control Transmission Protocol - Port Number"; number condition capability";
} reference
"RFC 793: Transmission Control Protocol - Port Number
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol
(TCP) Specification
RFC 768: User Datagram Protocol
RFC 4960: Stream Control Transmission Protocol
RFC 4340: Datagram Congestion Control Protocol";
}
identity sctp-verification-tag { identity destination-port-number {
base sctp-capability; base tcp;
description base udp;
"Identity for range-match SCTP verification tag condition base sctp;
capability"; base dccp;
reference description
"RFC 4960: Stream Control Transmission Protocol - Verification Tag"; "Identity for matching TCP, UDP, SCTP, and DCCP destination port
} number condition capability";
identity sctp-chunk-type { reference
base sctp-capability; "RFC 793: Transmission Control Protocol - Port Number
description draft-ietf-tcpm-rfc793bis: Transmission Control Protocol
"Identity for SCTP chunk type condition capability"; (TCP) Specification";
reference }
"RFC 4960: Stream Control Transmission Protocol - Chunk Type";
}
identity dccp-capability { identity flags {
description base tcp;
"Identity for DCCP condition capabilities"; description
reference "Identity for TCP control bits (flags) condition capability";
"RFC 4340: Datagram Congestion Control Protocol"; reference
} "RFC 793: Transmission Control Protocol - Flags
RFC 3168: The Addition of Explicit Congestion Notification
(ECN) to IP - TCP Header Flags
draft-ietf-tcpm-rfc793bis: Transmission Control Protocol
(TCP) Specification
draft-ietf-tcpm-accurate-ecn: More Accurate ECN Feedback
in TCP";
}
identity exact-dccp-port-num-flow-direction { identity tcp-options {
base dccp-capability; base tcp;
description description
"Identity for flow direction of exact-match DCCP source or "Identity for TCP options condition capability.";
destination port number condition capability where flow reference
direction is either unidirectional or bidirectional"; "RFC 793: Transmission Control Protocol - Options
reference draft-ietf-tcpm-rfc793bis: Transmission Control Protocol
"RFC 4340: Datagram Congestion Control Protocol"; (TCP) Specification
} RFC 6691: TCP Options and Maximum Segment Size
RFC 7323: TCP Extensions for High Performance";
}
identity exact-dccp-port-num { identity total-length {
base dccp-capability; base udp;
description description
"Identity for exact-match DCCP source or destination "Identity for matching UDP total-length condition capability.
port number condition capability"; The UDP total length can be smaller than the IP transport
reference length for UDP transport layer options.";
"RFC 4340: Datagram Congestion Control Protocol"; reference
} "RFC 768: User Datagram Protocol - Total Length
draft-ietf-tsvwg-udp-options: Transport Options for UDP";
}
identity exact-dccp-src-port-num { identity verification-tag {
base dccp-capability; base sctp;
description description
"Identity for exact-match DCCP source port number "Identity for range-match SCTP verification tag condition
condition capability"; capability";
reference reference
"RFC 4340: Datagram Congestion Control Protocol"; "RFC 4960: Stream Control Transmission Protocol - Verification
} Tag";
}
identity exact-dccp-dst-port-num { identity chunk-type {
base dccp-capability; base sctp;
description description
"Identity for exact-match DCCP destination port number "Identity for SCTP chunk type condition capability";
condition capability"; reference
"RFC 4960: Stream Control Transmission Protocol - Chunk Type";
}
reference identity service-code {
"RFC 4340: Datagram Congestion Control Protocol"; base dccp;
} description
"Identity for DCCP Service Code condition capabilitiy";
reference
"RFC 4340: Datagram Congestion Control Protocol
RFC 5595: The Datagram Congestion Control Protocol (DCCP)
Service Codes
RFC 6335: Internet Assigned Numbers Authority (IANA)
Procedures for the Management of the Service Name and
Transport Protocol Port Number Registry - Service Code";
}
identity range-dccp-port-num-flow-direction { identity application-protocol {
base dccp-capability; base protocol;
description description
"Identity for flow direction of range-match DCCP source or "Base identity for Application protocol";
destination port number condition capability where flow }
direction is either unidirectional or bidirectional";
reference
"RFC 4340: Datagram Congestion Control Protocol";
}
identity range-dccp-port-num { identity http {
base dccp-capability; base application-protocol;
description description
"Identity for range-match DCCP source or destination "The identity for HTTP protocol.";
port number condition capability. The port numbers are reference
specified by a pair of a start port number and an end "RFC 2616: Hypertext Transfer Protocol (HTTP)
port number."; RFC7230: Hypertext Transfer Protocol (HTTP/1.1): Message
reference Syntax and Routing
"RFC 4340: Datagram Congestion Control Protocol"; RFC7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics
} and Content";
}
identity range-dccp-src-port-num { identity https {
base dccp-capability; base application-protocol;
description description
"Identity for range-match DCCP source port number "The identity for HTTPS protocol.";
condition capability. The port numbers are specified by reference
a pair of a start port number and an end port number."; "RFC 2818: HTTP over TLS (HTTPS)
reference RFC7230: Hypertext Transfer Protocol (HTTP/1.1): Message
"RFC 4340: Datagram Congestion Control Protocol"; Syntax and Routing
} RFC7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics
and Content";
}
identity ftp {
base application-protocol;
description
"The identity for ftp protocol.";
reference
"RFC 959: File Transfer Protocol (FTP)";
}
identity range-dccp-dst-port-num { identity ssh {
base dccp-capability; base application-protocol;
description description
"Identity for range-match DCCP source port number "The identity for ssh protocol.";
condition capability. The port numbers are specified by reference
a pair of a start port number and an end port number."; "RFC 4250: The Secure Shell (SSH) Protocol";
reference }
"RFC 4340: Datagram Congestion Control Protocol";
}
identity dccp-service-code { identity telnet {
base dccp-capability; base application-protocol;
description description
"Identity for DCCP Service Code condition capabilitiy"; "The identity for telnet.";
reference reference
"RFC 4340: Datagram Congestion Control Protocol "RFC 854: Telnet Protocol";
RFC 5595: The Datagram Congestion Control Protocol (DCCP) }
Service Codes
RFC 6335: Internet Assigned Numbers Authority (IANA)
Procedures for the Management of the Service Name and
Transport Protocol Port Number Registry - Service Code";
}
identity icmp-capability { identity smtp {
base condition; base application-protocol;
description description
"Base identity for ICMP condition capability"; "The identity for smtp.";
reference reference
"RFC 792: Internet Control Message Protocol"; "RFC 5321: Simple Mail Transfer Protocol (SMTP)";
} }
identity icmp-type { identity sftp {
base icmp-capability; base application-protocol;
description description
"Identity for ICMP type condition capability"; "The identity for sftp.";
reference reference
"RFC 792: Internet Control Message Protocol"; "RFC 913: Simple File Transfer Protocol (SFTP)";
} }
identity icmp-code { identity pop3 {
base icmp-capability; base application-protocol;
description description
"Identity for ICMP code condition capability"; "The identity for pop3.";
reference reference
"RFC 792: Internet Control Message Protocol"; "RFC 1081: Post Office Protocol - Version 3 (POP3)";
} }
identity imap {
base application-protocol;
description
"The identity for Internet Message Access Protocol (IMAP).";
reference
"RFC 3501: INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1";
}
identity icmpv6-capability { identity action {
base condition; description
description "Base identity for action capability";
"Base identity for ICMPv6 condition capability"; }
reference
"RFC 4443: Internet Control Message Protocol (ICMPv6)
for the Internet Protocol Version 6 (IPv6) Specification
- ICMPv6";
}
identity icmpv6-type { identity log-action {
base icmpv6-capability; base action;
description description
"Identity for ICMPv6 type condition capability"; "Base identity for log-action capability";
}
reference identity ingress-action {
"RFC 4443: Internet Control Message Protocol (ICMPv6) base action;
for the Internet Protocol Version 6 (IPv6) Specification description
- ICMPv6"; "Base identity for ingress-action capability";
} reference
"RFC 8329: Framework for Interface to Network Security
Functions - Section 7.2";
}
identity icmpv6-code { identity egress-action {
base icmpv6-capability; base action;
description description
"Identity for ICMPv6 code condition capability"; "Base identity for egress-action capability";
reference reference
"RFC 4443: Internet Control Message Protocol (ICMPv6) "RFC 8329: Framework for Interface to Network Security
for the Internet Protocol Version 6 (IPv6) Specification Functions - Section 7.2";
- ICMPv6"; }
}
identity url-capability { identity default-action {
base condition; base action;
description description
"Base identity for URL condition capability"; "Base identity for default-action capability";
} }
identity pre-defined { identity rule-log {
base url-capability; base log-action;
description description
"Identity for pre-defined URL Database condition capability. "Identity for rule log-action capability.
where URL database is a public database for URL filtering."; Log the received packet based on the rule";
}
identity user-defined { }
base url-capability;
description
"Identity for user-defined URL Database condition capability.
that allows a users manual addition of URLs for URL
filtering.";
}
identity log-action-capability { identity session-log {
description base log-action;
"Base identity for log-action capability"; description
} "Identity for session log-action capability.
Log the received packet based on the session.";
}
identity rule-log { identity pass {
base log-action-capability; base ingress-action;
description base egress-action;
"Identity for rule log log-action capability. base default-action;
Log the received packet based on the rule"; description
} "Identity for pass action capability. The pass action allows
identity session-log { packet or flow to go through the NSF entering or exiting the
base log-action-capability; internal network.";
description }
"Identity for session log log-action capability.
Log the received packet based on the session.";
}
identity ingress-action-capability { identity drop {
description base ingress-action;
"Base identity for ingress-action capability"; base egress-action;
reference base default-action;
"RFC 8329: Framework for Interface to Network Security description
Functions - Ingress action"; "Identity for drop action capability. The drop action denies
} packet to go through the NSF entering or exiting the internal
network.";
}
identity egress-action-capability { identity mirror {
description base ingress-action;
"Base identity for egress-action capability"; base egress-action;
reference base default-action;
"RFC 8329: Framework for Interface to Network Security description
Functions - Egress action"; "Identity for mirror action capability. The mirror action copies
} packet and send it to the monitoring entity while still allow
the packet or flow to go through the NSF.";
}
identity default-action-capability { identity rate-limit {
description base ingress-action;
"Base identity for default-action capability"; base egress-action;
} base default-action;
description
"Identity for rate limiting action capability. The rate limit
action limits the number of packets or flows that can go through
the NSF by dropping packets or flows (randomly or
systematically).";
identity pass { }
base ingress-action-capability;
base egress-action-capability;
base default-action-capability;
description
"Identity for pass action capability";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Ingress, egress, and pass actions.";
}
identity drop { identity invoke-signaling {
base ingress-action-capability; base egress-action;
base egress-action-capability; description
base default-action-capability; "Identity for invoke signaling action capability";
description }
"Identity for drop action capability";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Ingress, egress, and drop actions.";
} identity tunnel-encapsulation {
base egress-action;
description
"Identity for tunnel encapsulation action capability";
}
identity alert { identity forwarding {
base ingress-action-capability; base egress-action;
base egress-action-capability; description
base default-action-capability; "Identity for forwarding action capability";
description }
"Identity for alert action capability";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Ingress, egress, and alert actions.
draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF
NSF Monitoring YANG Data Model - Alarm (i.e., alert).";
}
identity mirror { identity transformation {
base ingress-action-capability; base egress-action;
base egress-action-capability; description
base default-action-capability; "Identity for transformation action capability";
description }
"Identity for mirror action capability";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Ingress, egress, and mirror actions.";
}
identity invoke-signaling { identity resolution-strategy {
base egress-action-capability; description
description "Base identity for resolution strategy capability";
"Identity for invoke signaling action capability"; }
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Invoke-signaling action";
}
identity forwarding { identity fmr {
base egress-action-capability; base resolution-strategy;
description description
"Identity for forwarding action capability"; "Identity for First Matching Rule (FMR) resolution
reference strategy capability";
"RFC 8329: Framework for Interface to Network Security }
Functions - Forwarding action";
}
identity redirection { identity lmr {
base egress-action-capability; base resolution-strategy;
description description
"Identity for redirection action capability"; "Identity for Last Matching Rule (LMR) resolution
strategy capability";
}
reference identity pmr {
"RFC 8329: Framework for Interface to Network Security base resolution-strategy;
Functions - Redirection action"; description
} "Identity for Prioritized Matching Rule (PMR) resolution
strategy capability";
}
identity resolution-strategy-capability { identity pmre {
description base resolution-strategy;
"Base identity for resolution strategy capability"; description
} "Identity for Prioritized Matching Rule with Errors (PMRE)
resolution strategy capability";
}
identity fmr { identity pmrn {
base resolution-strategy-capability; base resolution-strategy;
description description
"Identity for First Matching Rule (FMR) resolution "Identity for Prioritized Matching Rule with No Errors (PMRN)
strategy capability"; resolution strategy capability";
} }
identity lmr { identity advanced-nsf {
base resolution-strategy-capability; description
description "Base identity for advanced Network Security Function (NSF)
"Identity for Last Matching Rule (LMR) resolution capability.";
strategy capability"; }
}
identity pmr { identity content-security-control {
base resolution-strategy-capability; base advanced-nsf;
description description
"Identity for Prioritized Matching Rule (PMR) resolution "Base identity for content security control. Content security
strategy capability"; control is an NSF that evaluates a packet's payload such as
} Intrusion Prevention System (IPS), URL-Filtering, Antivirus,
and VoIP/VoLTE Filter.";
}
identity pmre { identity attack-mitigation-control {
base resolution-strategy-capability; base advanced-nsf;
description description
"Identity for Prioritized Matching Rule with Errors (PMRE) "Base identity for attack mitigation control. Attack mitigation
resolution strategy capability"; control is an NSF that mitigates an attack such as anti-DDoS
} or DDoS-mitigator.";
}
identity pmrn { identity ips {
base resolution-strategy-capability; base content-security-control;
description description
"Identity for Prioritized Matching Rule with No Errors (PMRN) "Base identity for IPS (Intrusion Prevention System) capability
resolution strategy capability"; that prevents malicious activity within a network";
} }
identity url-filtering {
base content-security-control;
description
"Base identity for url filtering capability that limits access by
comparing the web traffic's URL with the URLs for web filtering
in a database";
}
identity advanced-nsf-capability { identity anti-virus {
description base content-security-control;
"Base identity for advanced Network Security Function (NSF) description
capability. This can be used for advanced NSFs such as "Base identity for anti-virus capability to protect the network
Anti-Virus, Anti-DDoS Attack, IPS, and VoIP/VoLTE Security by detecting and removing viruses.";
Service."; }
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF capability";
}
identity anti-virus-capability { identity voip-volte-filtering {
base advanced-nsf-capability; base content-security-control;
description description
"Identity for advanced NSF Anti-Virus capability. "Base identity for advanced NSF VoIP/VoLTE Security Service
This can be used for an extension point for Anti-Virus capability to filter the VoIP/VoLTE packets or flows.";
as an advanced NSF.";
reference reference
"RFC 8329: Framework for Interface to Network Security "RFC 3261: SIP: Session Initiation Protocol";
Functions - Advanced NSF Anti-Virus capability"; }
}
identity anti-ddos-capability {
base advanced-nsf-capability;
description
"Identity for advanced NSF Anti-DDoS Attack capability.
This can be used for an extension point for Anti-DDoS
Attack as an advanced NSF.";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF Anti-DDoS Attack capability";
}
identity ips-capability {
base advanced-nsf-capability;
description
"Identity for advanced NSF IPS capabilities. This can be
used for an extension point for IPS as an advanced NSF.";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF IPS capability";
}
identity voip-volte-capability {
base advanced-nsf-capability;
description
"Identity for advanced NSF VoIP/VoLTE Security Service
capability. This can be used for an extension point
for VoIP/VoLTE Security Service as an advanced NSF.";
reference
"RFC 3261: SIP: Session Initiation Protocol";
}
identity detect {
base anti-virus-capability;
description
"Identity for advanced NSF Anti-Virus Detection capability.
This can be used for an extension point for Anti-Virus
Detection as an advanced NSF.";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF Anti-Virus Detection capability";
}
identity allow-list {
base anti-virus-capability;
description
"Identity for advanced NSF Anti-Virus Allow List capability.
This can be used for an extension point for Anti-Virus
Allow List as an advanced NSF.";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF Anti-Virus Allow List capability";
}
identity syn-flood-action {
base anti-ddos-capability;
description
"Identity for advanced NSF Anti-DDoS SYN Flood Action
capability. This can be used for an extension point for
Anti-DDoS SYN Flood Action as an advanced NSF.";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF Anti-DDoS SYN Flood Action
capability";
}
identity udp-flood-action { identity anti-ddos {
base anti-ddos-capability; base attack-mitigation-control;
description description
"Identity for advanced NSF Anti-DDoS UDP Flood Action "Base identity for advanced NSF Anti-DDoS Attack or DDoS Mitigator
capability. This can be used for an extension point for capability.";
Anti-DDoS UDP Flood Action as an advanced NSF."; }
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF Anti-DDoS UDP Flood Action
capability";
}
identity http-flood-action {
base anti-ddos-capability;
description
"Identity for advanced NSF Anti-DDoS HTTP Flood Action
capability. This can be used for an extension point for
Anti-DDoS HTTP Flood Action as an advanced NSF.";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF Anti-DDoS HTTP Flood Action
capability";
}
identity https-flood-action { identity packet-rate {
base anti-ddos-capability; base anti-ddos;
description description
"Identity for advanced NSF Anti-DDoS HTTPS Flood Action "Identity for advanced NSF Anti-DDoS detecting Packet Rate
capability. This can be used for an extension point for Capability where a packet rate is defined as the arrival rate of
Anti-DDoS HTTPS Flood Action as an advanced NSF."; Packets toward a victim destination node. The NSF with this
reference capability can detect the incoming packet rate and create an
"RFC 8329: Framework for Interface to Network Security alert if the rate exceeds the threshold.";
Functions - Advanced NSF Anti-DDoS HTTPS Flood Action
capability";
}
identity dns-request-flood-action { }
base anti-ddos-capability;
description
"Identity for advanced NSF Anti-DDoS DNS Request Flood
Action capability. This can be used for an extension
point for Anti-DDoS DNS Request Flood Action as an
advanced NSF.";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF Anti-DDoS DNS Request Flood
Action capability";
}
identity dns-reply-flood-action { identity flow-rate {
base anti-ddos-capability; base anti-ddos;
description description
"Identity for advanced NSF Anti-DDoS DNS Reply Flood "Identity for advanced NSF Anti-DDoS detecting Flow Rate
Action capability. This can be used for an extension Capability where a flow rate is defined as the arrival rate of
point for Anti-DDoS DNS Reply Flood Action as an flows towards a victim destination node. The NSF with this
advanced NSF."; capability can detect the incoming flow rate and create an
reference alert if the rate exceeds the threshold.";
"RFC 8329: Framework for Interface to Network Security }
Functions - Advanced NSF Anti-DDoS DNS Reply Flood
Action capability";
} identity byte-rate {
base anti-ddos;
description
"Identity for advanced NSF Anti-DDoS detecting Byte Rate
Capability where a byte rate is defined as the arrival rate of
Bytes toward a victim destination node. The NSF with this
capability can detect the incoming byte rate and create an
alert if the rate exceeds the threshold.";
}
identity icmp-flood-action { identity signature-set {
base anti-ddos-capability; base ips;
description description
"Identity for advanced NSF Anti-DDoS ICMP Flood Action "Identity for the capability of IPS to set the signature.
capability. This can be used for an extension point Signature is a set of rules to detect an intrusive activity.";
for Anti-DDoS ICMP Flood Action as an advanced NSF."; reference
reference "RFC 4766: Intrusion Detection Message Exchange Requirements -
"RFC 8329: Framework for Interface to Network Security Section 2.2.13";
Functions - Advanced NSF Anti-DDoS ICMP Flood Action }
capability";
}
identity icmpv6-flood-action { identity exception-signature {
base anti-ddos-capability; base ips;
description description
"Identity for advanced NSF Anti-DDoS ICMPv6 Flood Action "Identity for the capability of IPS to exclude signatures from
capability. This can be used for an extension point detecting the intrusion.";
for Anti-DDoS ICMPv6 Flood Action as an advanced NSF."; reference
reference "RFC 4766: Intrusion Detection Message Exchange Requirements -
"RFC 8329: Framework for Interface to Network Security Section 2.2.13";
Functions - Advanced NSF Anti-DDoS ICMPv6 Flood Action }
capability";
}
identity sip-flood-action { identity detect {
base anti-ddos-capability; base anti-virus;
description description
"Identity for advanced NSF Anti-DDoS SIP Flood Action "Identity for advanced NSF Antivirus capability to detect viruses
capability. This can be used for an extension point using a security profile. The security profile is used to scan
for Anti-DDoS SIP Flood Action as an advanced NSF."; threats, such as virus, malware, and spyware. The NSF should
reference be able to update the security profile.";
"RFC 8329: Framework for Interface to Network Security }
Functions - Advanced NSF Anti-DDoS SIP Flood Action
capability";
}
identity detect-mode { identity exception-files {
base anti-ddos-capability; base anti-virus;
description description
"Identity for advanced NSF Anti-DDoS Detection Mode "Identity for advanced NSF Antivirus capability to exclude a
capability. This can be used for an extension point certain file type or name from detection.";
for Anti-DDoS Detection Mode as an advanced NSF.";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF Anti-DDoS Detection Mode
capability";
} }
identity baseline-learning { identity pre-defined {
base anti-ddos-capability; base url-filtering;
description description
"Identity for advanced NSF Anti-DDoS Baseline Learning "Identity for pre-defined URL Database condition capability.
capability. This can be used for an extension point where URL database is a public database for URL filtering.";
for Anti-DDoS Baseline Learning as an advanced NSF."; }
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF Anti-DDoS Baseline Learning
capability";
}
identity signature-set { identity user-defined {
base ips-capability; base url-filtering;
description description
"Identity for advanced NSF IPS Signature Set capability. "Identity for user-defined URL Database condition capability.
This can be used for an extension point for IPS Signature that allows a users manual addition of URLs for URL
Set as an advanced NSF."; filtering.";
reference }
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF IPS Signature Set capability";
}
identity ips-exception-signature { identity call-id {
base ips-capability; base voip-volte-filtering;
description description
"Identity for advanced NSF IPS Exception Signature "Identity for advanced NSF VoIP/VoLTE Call Identifier (ID)
capability. This can be used for an extension point for capability.";
IPS Exception Signature as an advanced NSF."; }
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF IPS Exception Signature Set
capability";
}
identity voip-volte-call-id { identity user-agent {
base voip-volte-capability; base voip-volte-filtering;
description description
"Identity for advanced NSF VoIP/VoLTE Call Identifier (ID) "Identity for advanced NSF VoIP/VoLTE User Agent capability.";
capability. This can be used for an extension point for }
VoIP/VoLTE Call ID as an advanced NSF.";
reference
"RFC 3261: SIP: Session Initiation Protocol";
}
identity user-agent { /*
base voip-volte-capability; * Grouping
description */
"Identity for advanced NSF VoIP/VoLTE User Agent capability.
This can be used for an extension point for VoIP/VoLTE
User Agent as an advanced NSF.";
reference
"RFC 3261: SIP: Session Initiation Protocol";
}
identity ipsec-capability { grouping nsf-capabilities {
description description
"Base identity for an IPsec capability"; "Network Security Function (NSF) Capabilities";
reference reference
"draft-ietf-i2nsf-sdn-ipsec-flow-protection-12: "RFC 8329: Framework for Interface to Network Security
Software-Defined Networking (SDN)-based IPsec Flow Functions - I2NSF Flow Security Policy Structure.";
Protection - IPsec methods such as IKE and IKE-less";
}
identity ike { leaf-list directional-capabilities {
base ipsec-capability; type identityref {
description base directional;
"Identity for an IPsec Internet Key Exchange (IKE) }
capability"; description
reference "The capability of an NSF for handling directional traffic
"draft-ietf-i2nsf-sdn-ipsec-flow-protection-12: flow (i.e., unidirectional or bidirectional traffic flow).";
Software-Defined Networking (SDN)-based IPsec Flow
Protection - IPsec method with IKE.
RFC 7296: Internet Key Exchange Protocol Version 2
(IKEv2) - IKE as a component of IPsec used for
performing mutual authentication and establishing and
maintaining Security Associations (SAs).";
}
identity ikeless { }
base ipsec-capability;
description
"Identity for an IPsec without Internet Key Exchange (IKE)
capability";
reference
"draft-ietf-i2nsf-sdn-ipsec-flow-protection-12:
Software-Defined Networking (SDN)-based IPsec Flow
Protection - IPsec method without IKE";
}
/* container event-capabilities {
* Grouping description
*/ "Capabilities of events.
If a network security function has the event capabilities,
the network security function supports rule execution
according to system event and system alarm.";
grouping nsf-capabilities { reference
description "RFC 8329: Framework for Interface to Network Security
"Network Security Function (NSF) Capabilities"; Functions - Section 7.
reference draft-ietf-i2nsf-nsf-monitoring-data-model-09: I2NSF
"RFC 8329: Framework for Interface to Network Security NSF Monitoring YANG Data Model - System Alarm and
Functions - I2NSF Flow Security Policy Structure."; System Events.";
leaf-list directional-capabilities { leaf-list system-event-capability {
type identityref { type identityref {
base directional-capability; base system-event;
} }
description description
"The capability of an NSF for handling directional traffic "System event capabilities";
flow (i.e., unidirectional or bidirectional traffic flow)."; }
}
leaf-list time-capabilities { leaf-list system-alarm-capability {
type enumeration { type identityref {
enum absolute-time { base system-alarm;
description }
"absolute time capabilities. description
If a network security function has the absolute time "System alarm capabilities";
capability, the network security function supports }
rule execution according to absolute time.";
}
enum periodic-time {
description
"periodic time capabilities.
If a network security function has the periodic time
capability, the network security function supports
rule execution according to periodic time.";
}
}
description
"Time capabilities";
}
container event-capabilities { leaf-list time-capabilities {
description type identityref {
"Capabilities of events. base time;
If a network security function has the event capabilities, }
the network security function supports rule execution description
according to system event and system alarm."; "The capabilities for activating the policy within a specific
time.";
}
}
reference container condition-capabilities {
"RFC 8329: Framework for Interface to Network Security description
Functions - I2NSF Flow Security Policy Structure. "Conditions capabilities.";
draft-ietf-i2nsf-nsf-monitoring-data-model-04: I2NSF container generic-nsf-capabilities {
NSF Monitoring YANG Data Model - System Alarm and description
System Events."; "Conditions capabilities.
leaf-list system-event-capability { If a network security function has the condition
type identityref { capabilities, the network security function
base system-event-capability; supports rule execution according to conditions of
} IPv4, IPv6, TCP, UDP, SCTP, DCCP, ICMP, or ICMPv6.";
description reference
"System event capabilities"; "RFC 768: User Datagram Protocol - UDP.
} RFC 791: Internet Protocol - IPv4.
RFC 792: Internet Control Message Protocol - ICMP.
RFC 793: Transmission Control Protocol - TCP.
RFC 4443: Internet Control Message Protocol (ICMPv6)
for the Internet Protocol Version 6 (IPv6) Specification
- ICMPv6.
RFC 4960: Stream Control Transmission Protocol - SCTP.
RFC 8200: Internet Protocol, Version 6 (IPv6)
Specification - IPv6.
RFC 8329: Framework for Interface to Network Security
Functions - I2NSF Flow Security Policy Structure.";
leaf-list system-alarm-capability { leaf-list ethernet-capability {
type identityref { type identityref {
base system-alarm-capability; base ethernet;
} }
description description
"System alarm capabilities"; "Media Access Control (MAC) capabilities";
} reference
} "IEEE 802.3: IEEE Standard for Ethernet";
}
container condition-capabilities { leaf-list ipv4-capability {
description type identityref {
"Conditions capabilities."; base ipv4;
}
description
"IPv4 packet capabilities";
reference
"RFC 791: Internet Protocol";
}
container generic-nsf-capabilities { leaf-list ipv6-capability {
description type identityref {
"Conditions capabilities. base ipv6;
If a network security function has the condition }
capabilities, the network security function description
supports rule execution according to conditions of "IPv6 packet capabilities";
IPv4, IPv6, TCP, UDP, SCTP, DCCP, ICMP, ICMPv6, or reference
payload."; "RFC 8200: Internet Protocol, Version 6 (IPv6)
reference Specification - IPv6";
"RFC 791: Internet Protocol - IPv4. }
RFC 792: Internet Control Message Protocol - ICMP. leaf-list icmpv4-capability {
RFC 793: Transmission Control Protocol - TCP. type identityref {
RFC 768: User Datagram Protocol - UDP. base icmpv4;
RFC 4960: Stream Control Transmission Protocol - SCTP. }
RFC 8200: Internet Protocol, Version 6 (IPv6) description
Specification - IPv6. "ICMPv4 packet capabilities";
RFC 4443: Internet Control Message Protocol (ICMPv6) reference
for the Internet Protocol Version 6 (IPv6) Specification "RFC 792: Internet Control Message Protocol - ICMP";
- ICMPv6. }
RFC 8329: Framework for Interface to Network Security
Functions - I2NSF Flow Security Policy Structure.";
leaf-list ipv4-capability { leaf-list icmpv6-capability {
type identityref { type identityref {
base ipv4-capability; base icmpv6;
} }
description description
"IPv4 packet capabilities"; "ICMPv6 packet capabilities";
reference reference
"RFC 791: Internet Protocol"; "RFC 4443: Internet Control Message Protocol (ICMPv6)
} for the Internet Protocol Version 6 (IPv6) Specification
- ICMPv6";
}
leaf-list icmp-capability { leaf-list tcp-capability {
type identityref { type identityref {
base icmp-capability; base tcp;
} }
description description
"ICMP packet capabilities"; "TCP packet capabilities";
reference reference
"RFC 792: Internet Control Message Protocol - ICMP"; "RFC 793: Transmission Control Protocol - TCP
} draft-ietf-tcpm-rfc793bis-24: Transmission Control
Protocol (TCP) Specification";
}
leaf-list ipv6-capability { leaf-list udp-capability {
type identityref { type identityref {
base ipv6-capability; base udp;
} }
description description
"IPv6 packet capabilities"; "UDP packet capabilities";
reference reference
"RFC 8200: Internet Protocol, Version 6 (IPv6) "RFC 768: User Datagram Protocol - UDP";
Specification - IPv6"; }
}
leaf-list icmpv6-capability { leaf-list sctp-capability {
type identityref { type identityref {
base icmpv6-capability; base sctp;
} }
description description
"ICMPv6 packet capabilities"; "SCTP packet capabilities";
reference reference
"RFC 4443: Internet Control Message Protocol (ICMPv6) "RFC 4960: Stream Control Transmission Protocol - SCTP";
for the Internet Protocol Version 6 (IPv6) Specification }
- ICMPv6";
}
leaf-list tcp-capability { leaf-list dccp-capability {
type identityref { type identityref {
base tcp-capability; base dccp;
} }
description description
"TCP packet capabilities"; "DCCP packet capabilities";
reference reference
"RFC 793: Transmission Control Protocol - TCP "RFC 4340: Datagram Congestion Control Protocol - DCCP";
draft-ietf-tcpm-rfc793bis-19: Transmission Control Protocol }
(TCP) Specification"; }
}
leaf-list udp-capability { container advanced-nsf-capabilities {
type identityref { description
base udp-capability; "Advanced Network Security Function (NSF) capabilities,
} such as Anti-DDoS, IPS, and VoIP/VoLTE.
description This container contains the leaf-lists of advanced
"UDP packet capabilities"; NSF capabilities";
reference
"RFC 768: User Datagram Protocol - UDP";
}
leaf-list sctp-capability { leaf-list anti-ddos-capability {
type identityref { type identityref {
base sctp-capability; base anti-ddos;
} }
description description
"SCTP packet capabilities"; "Anti-DDoS Attack capabilities";
reference }
"RFC 4960: Stream Control Transmission Protocol - SCTP";
}
leaf-list dccp-capability { leaf-list ips-capability {
type identityref { type identityref {
base dccp-capability; base ips;
} }
description description
"DCCP packet capabilities"; "IPS capabilities";
reference }
"RFC 4340: Datagram Congestion Control Protocol - DCCP";
}
}
container advanced-nsf-capabilities { leaf-list anti-virus-capability {
description type identityref {
"Advanced Network Security Function (NSF) capabilities, base anti-virus;
such as Anti-Virus, Anti-DDoS, IPS, and VoIP/VoLTE. }
This container contains the leaf-lists of advanced description
NSF capabilities"; "Anti-Virus capabilities";
reference }
"RFC 8329: Framework for Interface to Network Security leaf-list url-capability {
Functions - Advanced NSF capabilities"; type identityref {
base url-filtering;
}
description
"URL capabilities";
}
leaf-list anti-virus-capability { leaf-list voip-volte-filtering-capability {
type identityref { type identityref {
base anti-virus-capability; base voip-volte-filtering;
} }
description description
"Anti-Virus capabilities"; "VoIP/VoLTE capabilities";
reference }
"RFC 8329: Framework for Interface to Network Security }
Functions - Advanced NSF Anti-Virus capabilities";
}
leaf-list anti-ddos-capability { container context-capabilities {
type identityref { description
base anti-ddos-capability; "Security context capabilities";
} leaf-list application-filter-capabilities{
description type identityref {
"Anti-DDoS Attack capabilities"; base application-protocol;
reference }
"RFC 8329: Framework for Interface to Network Security description
Functions - Advanced NSF Anti-DDoS Attack capabilities"; "Context capabilities based on the application protocol";
} }
leaf-list ips-capability { leaf-list target-capabilities {
type identityref { type identityref {
base ips-capability; base target-device;
} }
description description
"IPS capabilities"; "Context capabilities based on the device attribute that
reference can identify a device type
"RFC 8329: Framework for Interface to Network Security (i.e., router, switch, pc, ios, or android).";
Functions - Advanced NSF IPS capabilities"; }
}
leaf-list url-capability { leaf-list user-condition-capabilities {
type identityref { type identityref {
base url-capability; base user-condition;
} }
description description
"URL capabilities"; "Context capabilities based on user condition, such as
reference user-id or user-name. The users can collected into a
"RFC 8329: Framework for Interface to Network Security user-group and identified with group-id or group-name.
Functions - Advanced NSF URL capabilities"; An NSF is aware of the IP address of the user provided by
} a unified user management system via network. Based on
name-address association, an NSF is able to enforce the
security functions over the given user (or user group)";
}
leaf-list voip-volte-capability { leaf-list geography-capabilities {
type identityref { type identityref {
base voip-volte-capability; base geography-location;
}
description
"Context condition capabilities based on the geographical
location of the source or destination";
}
} }
description }
"VoIP/VoLTE capabilities";
reference
"RFC 8329: Framework for Interface to Network Security
Functions - Advanced NSF VoIP/VoLTE capabilities";
}
}
leaf-list context-capabilities {
type identityref {
base context-capability;
}
description
"Security context capabilities";
}
}
container action-capabilities {
description
"Action capabilities.
If a network security function has the action capabilities,
the network security function supports the attendant
actions for policy rules.";
leaf-list ingress-action-capability { container action-capabilities {
type identityref { description
base ingress-action-capability; "Action capabilities.
} If a network security function has the action capabilities,
description the network security function supports the attendant
"Ingress-action capabilities"; actions for policy rules.";
}
leaf-list egress-action-capability { leaf-list ingress-action-capability {
type identityref { type identityref {
base egress-action-capability; base ingress-action;
} }
description description
"Egress-action capabilities"; "Ingress-action capabilities";
} }
leaf-list log-action-capability { leaf-list egress-action-capability {
type identityref { type identityref {
base log-action-capability; base egress-action;
} }
description description
"Log-action capabilities"; "Egress-action capabilities";
} }
}
leaf-list resolution-strategy-capabilities { leaf-list log-action-capability {
type identityref { type identityref {
base resolution-strategy-capability; base log-action;
} }
description description
"Resolution strategy capabilities. "Log-action capabilities";
The resolution strategies can be used to specify how }
to resolve conflicts that occur between the actions }
of the same or different policy rules that are matched
for the same packet and by particular NSF.";
}
leaf-list default-action-capabilities { leaf-list resolution-strategy-capabilities {
type identityref { type identityref {
base default-action-capability; base resolution-strategy;
} }
description description
"Default action capabilities. "Resolution strategy capabilities.
A default action is used to execute I2NSF policy rules The resolution strategies can be used to specify how
when no rule matches a packet. The default action is to resolve conflicts that occur between the actions
defined as pass, drop, alert, or mirror. Note that of the same or different policy rules that are matched
alert makes a packet dropped and logged."; for the same packet and by particular NSF.";
reference }
"RFC 8329: Framework for Interface to Network Security
Functions - Ingress and egress actions.";
}
leaf-list ipsec-method { leaf-list default-action-capabilities {
type identityref { type identityref {
base ipsec-capability; base default-action;
} }
description description
"IPsec method capabilities"; "Default action capabilities.
reference A default action is used to execute I2NSF policy rules
"draft-ietf-i2nsf-sdn-ipsec-flow-protection-12: when no rule matches a packet. The default action is
Software-Defined Networking (SDN)-based IPsec Flow defined as pass, drop, rate-limit, or mirror.";
Protection - IPsec methods such as IKE and IKE-less"; }
} }
}
/* /*
* Data nodes * Data nodes
*/ */
list nsf { list nsf {
key "nsf-name"; key "nsf-name";
description description
"The list of Network Security Functions (NSFs)"; "The list of Network Security Functions (NSFs)";
leaf nsf-name { leaf nsf-name {
type string; type string;
mandatory true; mandatory true;
description description
"The name of Network Security Function (NSF)"; "The name of Network Security Function (NSF)";
} }
uses nsf-capabilities; uses nsf-capabilities;
} }
} }
<CODE ENDS> <CODE ENDS>
Figure 3: YANG Data Module of I2NSF Capability Figure 3: YANG Data Module of I2NSF Capability
7. IANA Considerations 7. IANA Considerations
This document requests IANA to register the following URI in the This document requests IANA to register the following URI in the
"IETF XML Registry" [RFC3688]: "IETF XML Registry" [RFC3688]:
ID: yang:ietf-i2nsf-capability ID: yang:ietf-i2nsf-capability
URI: urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability URI: urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability
Registrant Contact: The IESG. Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace. XML: N/A; the requested URI is an XML namespace.
skipping to change at page 59, line 40 skipping to change at page 49, line 24
Name: ietf-i2nsf-capability Name: ietf-i2nsf-capability
Maintained by IANA? N Maintained by IANA? N
Namespace: urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability Namespace: urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability
Prefix: nsfcap Prefix: nsfcap
Module: Module:
Reference: [ RFC-to-be ] Reference: [ RFC-to-be ]
8. Privacy Considerations 8. Privacy Considerations
This YANG module specified in this document make a trade-off between This YANG module specifies the capabilities for NSFs. Some of the
privacy and security. Some part of the YANG data model specified in capabilities in this document MAY require highly sensitive private
this document might use highly sensitive private data of the client. data to operate properly. The usage of such capability MUST be
The data used in this YANG data model can be used for the NSFs to reported to the users and permitted before using the private
improve the security of the network. information related to the capability. Using any of the capabilities
that require private data MUST preserve the privacy by preventing any
leakage or unauthorized disclosure of the private data.
In regards to the privacy data used, the security for accessibility In regards to the privacy data used, the security for accessibility
of the data should be tightly secured and monitored. The Security of the data should be tightly secured and monitored. The Security
Considerations are discussed in Section 9. Considerations are discussed in Section 9.
9. Security Considerations 9. Security Considerations
The YANG module specified in this document defines a data schema The YANG module specified in this document defines a data schema
designed to be accessed through network management protocols such as designed to be accessed through network management protocols such as
NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest layer of NETCONF NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest layer of NETCONF
protocol layers can use Secure Shell (SSH) [RFC4254][RFC6242] as a protocol layers MUST use Secure Shell (SSH) [RFC4254][RFC6242] as a
secure transport layer. The lowest layer of RESTCONF protocol layers secure transport layer. The lowest layer of RESTCONF protocol layers
can use HTTP over Transport Layer Security (TLS), that is, HTTPS MUST use HTTP over Transport Layer Security (TLS), that is, HTTPS
[RFC7230][RFC8446] as a secure transport layer. [RFC7230][RFC8446] as a secure transport layer.
The Network Configuration Access Control Model (NACM) [RFC8341] The Network Configuration Access Control Model (NACM) [RFC8341]
provides a means of restricting access to specific NETCONF or provides a means of restricting access to specific NETCONF or
RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or
RESTCONF protocol operations and contents. Thus, NACM can be used to RESTCONF protocol operations and contents. Thus, NACM SHOULD be used
restrict the NSF registration from unauthorized users. to restrict the NSF registration from unauthorized users.
There are a number of data nodes defined in this YANG module that are There are a number of data nodes defined in this YANG module that are
writable, creatable, and deletable (i.e., config true, which is the writable, creatable, and deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations to these data nodes in some network environments. Write operations to these data nodes
could have a negative effect on network and security operations. could have a negative effect on network and security operations.
These data nodes are collected into a single list node. This list These data nodes are collected into a single list node. This list
node is defined by list nsf with the following sensitivity/ node is defined by list nsf with the following sensitivity/
vulnerability: vulnerability:
o list nsf: An attacker could alter the security capabilities * list nsf: An attacker could alter the security capabilities
associated with an NSF by disabling or enabling the functionality associated with an NSF by disabling or enabling the functionality
of the security capabilities of the NSF. of the security capabilities of the NSF.
Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or
notification) to these data nodes. These are the subtrees and data
nodes with their sensitivity/vulnerability:
* list nsf: The leak of this node to an attacker could reveal the
specific configuration of security controls to an attacker. An
attacker can craft an attack path that avoids observation or
mitigations; one may reveal topology information to inform
additional targets or enable lateral movement; one enables the
construction of an attack path that avoids observation or
mitigations; one provides an indication that the operator has
discovered the attack.
Some of the features that this document defines capability indicators Some of the features that this document defines capability indicators
for are highly sensitive and/or privileged operations (e.g., for are highly sensitive and/or privileged operations that inherently
listening to VoIP/VoLTE audio to identify individuals and web require access to individuals' private data. These are subtrees and
filtering) that inherently require access to individuals' private data nodes that are considered privacy sensitive:
data. It is noted that private information is made accessible in
this manner. Thus, the nodes/entities given access to this data need * voip-volte-filtering-capability: The NSF that is able to filter
to be tightly secured and monitored, to prevent leakage or other VoIP/VoLTE calls might identify certain individual identification.
* user-condition-capabilities: The capability uses a set of IP
addresses mapped to users.
* geography-capabilities: The IP address used in this capability can
identify a user's geographical location.
It is noted that some private information is made accessible in this
manner. Thus, the nodes/entities given access to this data MUST be
tightly secured, monitored, and audited to prevent leakage or other
unauthorized disclosure of private data. Refer to [RFC6973] for the unauthorized disclosure of private data. Refer to [RFC6973] for the
description of privacy aspects that protocol designers (including description of privacy aspects that protocol designers (including
YANG data model designers) should consider along with regular YANG data model designers) should consider along with regular
security and privacy analysis. security and privacy analysis.
10. References 10. References
10.1. Normative References 10.1. Normative References
[I-D.ietf-i2nsf-nsf-monitoring-data-model]
Jeong, J., Lingga, P., Hares, S., Xia, L., and H.
Birkholz, "I2NSF NSF Monitoring YANG Data Model", draft-
ietf-i2nsf-nsf-monitoring-data-model-04 (work in
progress), September 2020.
[I-D.ietf-i2nsf-sdn-ipsec-flow-protection]
Marin-Lopez, R., Lopez-Millan, G., and F. Pereniguez-
Garcia, "Software-Defined Networking (SDN)-based IPsec
Flow Protection", draft-ietf-i2nsf-sdn-ipsec-flow-
protection-12 (work in progress), October 2020.
[I-D.ietf-tcpm-accurate-ecn]
Briscoe, B., Kuehlewind, M., and R. Scheffenegger, "More
Accurate ECN Feedback in TCP", draft-ietf-tcpm-accurate-
ecn-13 (work in progress), November 2020.
[I-D.ietf-tcpm-rfc793bis]
Eddy, W., "Transmission Control Protocol (TCP)
Specification", draft-ietf-tcpm-rfc793bis-20 (work in
progress), January 2021.
[I-D.ietf-tsvwg-udp-options]
Touch, J., "Transport Options for UDP", draft-ietf-tsvwg-
udp-options-09 (work in progress), November 2020.
[RFC0768] Postel, J., "User Datagram Protocol", STD 6, RFC 768, [RFC0768] Postel, J., "User Datagram Protocol", STD 6, RFC 768,
DOI 10.17487/RFC0768, August 1980, DOI 10.17487/RFC0768, August 1980,
<https://www.rfc-editor.org/info/rfc768>. <https://www.rfc-editor.org/info/rfc768>.
[RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791, [RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791,
DOI 10.17487/RFC0791, September 1981, DOI 10.17487/RFC0791, September 1981,
<https://www.rfc-editor.org/info/rfc791>. <https://www.rfc-editor.org/info/rfc791>.
[RFC0792] Postel, J., "Internet Control Message Protocol", STD 5, [RFC0792] Postel, J., "Internet Control Message Protocol", STD 5,
RFC 792, DOI 10.17487/RFC0792, September 1981, RFC 792, DOI 10.17487/RFC0792, September 1981,
skipping to change at page 62, line 22 skipping to change at page 52, line 11
of Explicit Congestion Notification (ECN) to IP", of Explicit Congestion Notification (ECN) to IP",
RFC 3168, DOI 10.17487/RFC3168, September 2001, RFC 3168, DOI 10.17487/RFC3168, September 2001,
<https://www.rfc-editor.org/info/rfc3168>. <https://www.rfc-editor.org/info/rfc3168>.
[RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
A., Peterson, J., Sparks, R., Handley, M., and E. A., Peterson, J., Sparks, R., Handley, M., and E.
Schooler, "SIP: Session Initiation Protocol", RFC 3261, Schooler, "SIP: Session Initiation Protocol", RFC 3261,
DOI 10.17487/RFC3261, June 2002, DOI 10.17487/RFC3261, June 2002,
<https://www.rfc-editor.org/info/rfc3261>. <https://www.rfc-editor.org/info/rfc3261>.
[RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION
4rev1", RFC 3501, DOI 10.17487/RFC3501, March 2003,
<https://www.rfc-editor.org/info/rfc3501>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>. <https://www.rfc-editor.org/info/rfc3688>.
[RFC4254] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH) [RFC4254] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH)
Connection Protocol", RFC 4254, DOI 10.17487/RFC4254, Connection Protocol", RFC 4254, DOI 10.17487/RFC4254,
January 2006, <https://www.rfc-editor.org/info/rfc4254>. January 2006, <https://www.rfc-editor.org/info/rfc4254>.
[RFC4340] Kohler, E., Handley, M., and S. Floyd, "Datagram [RFC4340] Kohler, E., Handley, M., and S. Floyd, "Datagram
Congestion Control Protocol (DCCP)", RFC 4340, Congestion Control Protocol (DCCP)", RFC 4340,
skipping to change at page 63, line 26 skipping to change at page 53, line 21
Procedures for the Management of the Service Name and Procedures for the Management of the Service Name and
Transport Protocol Port Number Registry", BCP 165, Transport Protocol Port Number Registry", BCP 165,
RFC 6335, DOI 10.17487/RFC6335, August 2011, RFC 6335, DOI 10.17487/RFC6335, August 2011,
<https://www.rfc-editor.org/info/rfc6335>. <https://www.rfc-editor.org/info/rfc6335>.
[RFC6437] Amante, S., Carpenter, B., Jiang, S., and J. Rajahalme, [RFC6437] Amante, S., Carpenter, B., Jiang, S., and J. Rajahalme,
"IPv6 Flow Label Specification", RFC 6437, "IPv6 Flow Label Specification", RFC 6437,
DOI 10.17487/RFC6437, November 2011, DOI 10.17487/RFC6437, November 2011,
<https://www.rfc-editor.org/info/rfc6437>. <https://www.rfc-editor.org/info/rfc6437>.
[RFC6691] Borman, D., "TCP Options and Maximum Segment Size (MSS)",
RFC 6691, DOI 10.17487/RFC6691, July 2012,
<https://www.rfc-editor.org/info/rfc6691>.
[RFC6864] Touch, J., "Updated Specification of the IPv4 ID Field", [RFC6864] Touch, J., "Updated Specification of the IPv4 ID Field",
RFC 6864, DOI 10.17487/RFC6864, February 2013, RFC 6864, DOI 10.17487/RFC6864, February 2013,
<https://www.rfc-editor.org/info/rfc6864>. <https://www.rfc-editor.org/info/rfc6864>.
[RFC6973] Cooper, A., Tschofenig, H., Aboba, B., Peterson, J.,
Morris, J., Hansen, M., and R. Smith, "Privacy
Considerations for Internet Protocols", RFC 6973,
DOI 10.17487/RFC6973, July 2013,
<https://www.rfc-editor.org/info/rfc6973>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013, RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>. <https://www.rfc-editor.org/info/rfc6991>.
[RFC7230] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer [RFC7230] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Message Syntax and Routing", Protocol (HTTP/1.1): Message Syntax and Routing",
RFC 7230, DOI 10.17487/RFC7230, June 2014, RFC 7230, DOI 10.17487/RFC7230, June 2014,
<https://www.rfc-editor.org/info/rfc7230>. <https://www.rfc-editor.org/info/rfc7230>.
[RFC7231] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer [RFC7231] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
skipping to change at page 64, line 23 skipping to change at page 54, line 9
<https://www.rfc-editor.org/info/rfc7323>. <https://www.rfc-editor.org/info/rfc7323>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016, RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>. <https://www.rfc-editor.org/info/rfc7950>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>. <https://www.rfc-editor.org/info/rfc8040>.
[RFC8192] Hares, S., Lopez, D., Zarny, M., Jacquenet, C., Kumar, R., [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
and J. Jeong, "Interface to Network Security Functions 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
(I2NSF): Problem Statement and Use Cases", RFC 8192, May 2017, <https://www.rfc-editor.org/info/rfc8174>.
DOI 10.17487/RFC8192, July 2017,
<https://www.rfc-editor.org/info/rfc8192>.
[RFC8200] Deering, S. and R. Hinden, "Internet Protocol, Version 6 [RFC8200] Deering, S. and R. Hinden, "Internet Protocol, Version 6
(IPv6) Specification", STD 86, RFC 8200, (IPv6) Specification", STD 86, RFC 8200,
DOI 10.17487/RFC8200, July 2017, DOI 10.17487/RFC8200, July 2017,
<https://www.rfc-editor.org/info/rfc8200>. <https://www.rfc-editor.org/info/rfc8200>.
[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,
<https://www.rfc-editor.org/info/rfc8329>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>. <https://www.rfc-editor.org/info/rfc8340>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341, Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018, DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>. <https://www.rfc-editor.org/info/rfc8341>.
[RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of [RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of
Documents Containing YANG Data Models", BCP 216, RFC 8407, Documents Containing YANG Data Models", BCP 216, RFC 8407,
DOI 10.17487/RFC8407, October 2018, DOI 10.17487/RFC8407, October 2018,
<https://www.rfc-editor.org/info/rfc8407>. <https://www.rfc-editor.org/info/rfc8407>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>. <https://www.rfc-editor.org/info/rfc8446>.
[RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K.,
and R. Wilton, "YANG Library", RFC 8525,
DOI 10.17487/RFC8525, March 2019,
<https://www.rfc-editor.org/info/rfc8525>.
[RFC8519] Jethanandani, M., Agarwal, S., Huang, L., and D. Blair, [RFC8519] Jethanandani, M., Agarwal, S., Huang, L., and D. Blair,
"YANG Data Model for Network Access Control Lists (ACLs)", "YANG Data Model for Network Access Control Lists (ACLs)",
RFC 8519, DOI 10.17487/RFC8519, March 2019, RFC 8519, DOI 10.17487/RFC8519, March 2019,
<https://www.rfc-editor.org/info/rfc8519>. <https://www.rfc-editor.org/info/rfc8519>.
[RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K., [I-D.ietf-tcpm-accurate-ecn]
and R. Wilton, "YANG Library", RFC 8525, Briscoe, B., K├╝hlewind, M., and R. Scheffenegger, "More
DOI 10.17487/RFC8525, March 2019, Accurate ECN Feedback in TCP", Work in Progress, Internet-
<https://www.rfc-editor.org/info/rfc8525>. Draft, draft-ietf-tcpm-accurate-ecn-15, 12 July 2021,
<https://www.ietf.org/archive/id/draft-ietf-tcpm-accurate-
ecn-15.txt>.
[I-D.ietf-tsvwg-udp-options]
Touch, J., "Transport Options for UDP", Work in Progress,
Internet-Draft, draft-ietf-tsvwg-udp-options-13, 19 June
2021, <https://www.ietf.org/archive/id/draft-ietf-tsvwg-
udp-options-13.txt>.
[I-D.ietf-i2nsf-nsf-monitoring-data-model]
Jeong, J. (., Lingga, P., Hares, S., Xia, L. (., and H.
Birkholz, "I2NSF NSF Monitoring Interface YANG Data
Model", Work in Progress, Internet-Draft, draft-ietf-
i2nsf-nsf-monitoring-data-model-08, 29 April 2021,
<https://www.ietf.org/archive/id/draft-ietf-i2nsf-nsf-
monitoring-data-model-08.txt>.
[I-D.ietf-i2nsf-nsf-facing-interface-dm]
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,
<https://www.ietf.org/archive/id/draft-ietf-i2nsf-nsf-
facing-interface-dm-12.txt>.
[I-D.ietf-i2nsf-registration-interface-dm]
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,
<https://www.ietf.org/archive/id/draft-ietf-i2nsf-
registration-interface-dm-10.txt>.
10.2. Informative References 10.2. Informative References
[RFC6691] Borman, D., "TCP Options and Maximum Segment Size (MSS)",
RFC 6691, DOI 10.17487/RFC6691, July 2012,
<https://www.rfc-editor.org/info/rfc6691>.
[RFC6973] Cooper, A., Tschofenig, H., Aboba, B., Peterson, J.,
Morris, J., Hansen, M., and R. Smith, "Privacy
Considerations for Internet Protocols", RFC 6973,
DOI 10.17487/RFC6973, July 2013,
<https://www.rfc-editor.org/info/rfc6973>.
[RFC8192] Hares, S., Lopez, D., Zarny, M., Jacquenet, C., Kumar, R.,
and J. Jeong, "Interface to Network Security Functions
(I2NSF): Problem Statement and Use Cases", RFC 8192,
DOI 10.17487/RFC8192, July 2017,
<https://www.rfc-editor.org/info/rfc8192>.
[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,
<https://www.rfc-editor.org/info/rfc8329>.
[RFC8805] Kline, E., Duleba, K., Szamonek, Z., Moser, S., and W.
Kumari, "A Format for Self-Published IP Geolocation
Feeds", RFC 8805, DOI 10.17487/RFC8805, August 2020,
<https://www.rfc-editor.org/info/rfc8805>.
[I-D.ietf-tcpm-rfc793bis]
Eddy, W. M., "Transmission Control Protocol (TCP)
Specification", Work in Progress, Internet-Draft, draft-
ietf-tcpm-rfc793bis-24, 12 July 2021,
<https://www.ietf.org/archive/id/draft-ietf-tcpm-
rfc793bis-24.txt>.
[IANA-Protocol-Numbers]
"Assigned Internet Protocol Numbers", Available:
https://www.iana.org/assignments/protocol-
numbers/protocol-numbers.xhtml, September 2020.
[Alshaer] Shaer, Al., Hamed, E., and H. Hamed, "Modeling and [Alshaer] Shaer, Al., Hamed, E., and H. Hamed, "Modeling and
management of firewall policies", 2004. management of firewall policies", 2004.
[Galitsky] [Galitsky] Galitsky, B. and R. Pampapathi, "Can many agents answer
Galitsky, B. and R. Pampapathi, "Can many agents answer
questions better than one", First questions better than one", First
Monday http://dx.doi.org/10.5210/fm.v10i1.1204, 2005. Monday http://dx.doi.org/10.5210/fm.v10i1.1204, 2005.
[Hirschman] [Hirschman]
Hirschman, L. and R. Gaizauskas, "Natural Language Hirschman, L. and R. Gaizauskas, "Natural Language
Question Answering: The View from Here", Natural Language Question Answering: The View from Here", Natural Language
Engineering 7:4, pgs 275-300, Cambridge University Press , Engineering 7:4, pgs 275-300, Cambridge University Press ,
Nov 2001. November 2001.
[Hohpe] Hohpe, G. and B. Woolf, "Enterprise Integration Patterns", [Hohpe] Hohpe, G. and B. Woolf, "Enterprise Integration Patterns",
ISBN 0-32-120068-3 , 2003. ISBN 0-32-120068-3 , 2003.
[IANA-Protocol-Numbers] [Martin] Martin, R.C., "Agile Software Development, Principles,
"Assigned Internet Protocol Numbers", Available:
https://www.iana.org/assignments/protocol-
numbers/protocol-numbers.xhtml, September 2020.
[Martin] Martin, R., "Agile Software Development, Principles,
Patterns, and Practices", Prentice-Hall , ISBN: Patterns, and Practices", Prentice-Hall , ISBN:
0-13-597444-5 , 2002. 0-13-597444-5 , 2002.
[OODMP] "http://www.oodesign.com/mediator-pattern.html". [OODMP] "http://www.oodesign.com/mediator-pattern.html".
[OODOP] "http://www.oodesign.com/mediator-pattern.html". [OODOP] "http://www.oodesign.com/mediator-pattern.html".
[OODSRP] "http://www.oodesign.com/mediator-pattern.html". [OODSRP] "http://www.oodesign.com/mediator-pattern.html".
[RFC8805] Kline, E., Duleba, K., Szamonek, Z., Moser, S., and W.
Kumari, "A Format for Self-Published IP Geolocation
Feeds", RFC 8805, DOI 10.17487/RFC8805, August 2020,
<https://www.rfc-editor.org/info/rfc8805>.
Appendix A. Configuration Examples Appendix A. Configuration Examples
This section shows configuration examples of "ietf-i2nsf-capability" This section shows configuration examples of "ietf-i2nsf-capability"
module for capabilities registration of general firewall. module for capabilities registration of general firewall.
A.1. Example 1: Registration for the Capabilities of a General Firewall A.1. Example 1: Registration for the Capabilities of a General Firewall
This section shows a configuration example for the capabilities This section shows a configuration example for the capabilities
registration of a general firewall in either an IPv4 network or an registration of a general firewall in either an IPv4 network or an
IPv6 network. IPv6 network.
<nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability"> <nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-name>general_firewall</nsf-name> <nsf-name>general_firewall</nsf-name>
<condition-capabilities> <condition-capabilities>
<generic-nsf-capabilities> <generic-nsf-capabilities>
<ipv4-capability>ipv4-protocol</ipv4-capability> <ipv4-capability>next-header</ipv4-capability>
<ipv4-capability>prefix-ipv4-address-flow-direction</ipv4-capability> <ipv4-capability>flow-direction</ipv4-capability>
<ipv4-capability>prefix-ipv4-address</ipv4-capability> <ipv4-capability>source-address</ipv4-capability>
<ipv4-capability>range-ipv4-address-flow-direction</ipv4-capability> <ipv4-capability>destination-address</ipv4-capability>
<ipv4-capability>range-ipv4-address</ipv4-capability> <tcp-capability>source-port-number</tcp-capability>
<tcp-capability>exact-tcp-port-num-flow-direction</tcp-capability> <tcp-capability>destination-port-number</tcp-capability>
<tcp-capability>exact-tcp-src-port-num</tcp-capability> <udp-capability>source-port-num</udp-capability>
<tcp-capability>exact-tcp-dst-port-num</tcp-capability> <udp-capability>destination-port-num</udp-capability>
<tcp-capability>range-tcp-port-num-flow-direction</tcp-capability> </generic-nsf-capabilities>
<tcp-capability>range-tcp-src-port-num</tcp-capability> </condition-capabilities>
<tcp-capability>range-tcp-dst-port-num</tcp-capability> <action-capabilities>
<udp-capability>exact-udp-port-num-flow-direction</udp-capability> <ingress-action-capability>pass</ingress-action-capability>
<udp-capability>exact-udp-src-port-num</udp-capability> <ingress-action-capability>drop</ingress-action-capability>
<udp-capability>exact-udp-dst-port-num</udp-capability> <ingress-action-capability>mirror</ingress-action-capability>
<udp-capability>range-udp-port-num-flow-direction</udp-capability> <egress-action-capability>pass</egress-action-capability>
<udp-capability>range-udp-src-port-num</udp-capability> <egress-action-capability>drop</egress-action-capability>
<udp-capability>range-udp-dst-port-num</udp-capability> <egress-action-capability>mirror</egress-action-capability>
</generic-nsf-capabilities> </action-capabilities>
</condition-capabilities> </nsf>
<action-capabilities>
<ingress-action-capability>pass</ingress-action-capability>
<ingress-action-capability>drop</ingress-action-capability>
<ingress-action-capability>alert</ingress-action-capability>
<egress-action-capability>pass</egress-action-capability>
<egress-action-capability>drop</egress-action-capability>
<egress-action-capability>alert</egress-action-capability>
</action-capabilities>
</nsf>
Figure 4: Configuration XML for the Capabilities Registration of a Figure 4: Configuration XML for the Capabilities Registration of
General Firewall in an IPv4 Network a General Firewall in an IPv4 Network
Figure 4 shows the configuration XML for the capabilities Figure 4 shows the configuration XML for the capabilities
registration of a general firewall as an NSF in an IPv4 network. Its registration of a general firewall as an NSF in an IPv4 network. Its
capabilities are as follows. capabilities are as follows.
1. The name of the NSF is general_firewall. 1. The name of the NSF is general_firewall.
2. The NSF can inspect a protocol, a prefix of IPv4 addresses, and a 2. The NSF can inspect the IPv4 protocol header field, flow
range of IPv4 addresses for IPv4 packets. direction, source address(es), and destination address(es)
3. The NSF can inspect an exact port number and a range of port 3. The NSF can inspect the port number(s) and flow direction for the
numbers for the transport layer (TCP and UDP). transport layer protocol, i.e., TCP and UDP.
4. The NSF can control whether the packets are allowed to pass, 4. The NSF can control whether the packets are allowed to pass,
drop, or alert. drop, or mirror.
<nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability"> <nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-name>general_firewall</nsf-name> <nsf-name>general_firewall</nsf-name>
<condition-capabilities> <condition-capabilities>
<generic-nsf-capabilities> <generic-nsf-capabilities>
<ipv6-capability>ipv6-next-header</ipv6-capability> <ipv6-capability>next-header</ipv6-capability>
<ipv6-capability>prefix-ipv6-address-flow-direction</ipv6-capability> <ipv6-capability>flow-direction</ipv6-capability>
<ipv6-capability>prefix-ipv6-address</ipv6-capability> <ipv6-capability>source-address</ipv6-capability>
<ipv6-capability>range-ipv6-address-flow-direction</ipv6-capability> <ipv6-capability>destination-address</ipv6-capability>
<ipv6-capability>range-ipv6-address</ipv6-capability> <tcp-capability>source-port-number</tcp-capability>
<tcp-capability>exact-tcp-port-num-flow-direction</tcp-capability> <tcp-capability>destination-port-number</tcp-capability>
<tcp-capability>exact-tcp-src-port-num</tcp-capability> <udp-capability>source-port-num</udp-capability>
<tcp-capability>exact-tcp-dst-port-num</tcp-capability> <udp-capability>destination-port-num</udp-capability>
<tcp-capability>range-tcp-port-num-flow-direction</tcp-capability> </generic-nsf-capabilities>
<tcp-capability>range-tcp-src-port-num</tcp-capability> </condition-capabilities>
<tcp-capability>range-tcp-dst-port-num</tcp-capability> <action-capabilities>
<udp-capability>exact-udp-port-num-flow-direction</udp-capability> <ingress-action-capability>pass</ingress-action-capability>
<udp-capability>exact-udp-src-port-num</udp-capability> <ingress-action-capability>drop</ingress-action-capability>
<udp-capability>exact-udp-dst-port-num</udp-capability> <ingress-action-capability>mirror</ingress-action-capability>
<udp-capability>range-udp-port-num-flow-direction</udp-capability> <egress-action-capability>pass</egress-action-capability>
<udp-capability>range-udp-src-port-num</udp-capability> <egress-action-capability>drop</egress-action-capability>
<udp-capability>range-udp-dst-port-num</udp-capability> <egress-action-capability>mirror</egress-action-capability>
</generic-nsf-capabilities> </action-capabilities>
</condition-capabilities> </nsf>
<action-capabilities>
<ingress-action-capability>pass</ingress-action-capability>
<ingress-action-capability>drop</ingress-action-capability>
<ingress-action-capability>alert</ingress-action-capability>
<egress-action-capability>pass</egress-action-capability>
<egress-action-capability>drop</egress-action-capability>
<egress-action-capability>alert</egress-action-capability>
</action-capabilities>
</nsf>
Figure 5: Configuration XML for the Capabilities Registration of a Figure 5: Configuration XML for the Capabilities Registration of
General Firewall in an IPv6 Network a General Firewall in an IPv6 Network
In addition, Figure 5 shows the configuration XML for the In addition, Figure 5 shows the configuration XML for the
capabilities registration of a general firewall as an NSF in an IPv6 capabilities registration of a general firewall as an NSF in an IPv6
network. Its capabilities are as follows. network. Its capabilities are as follows.
1. The name of the NSF is general_firewall. 1. The name of the NSF is general_firewall.
2. The NSF can inspect a protocol (Next-Header), a prefix of IPv6 2. The NSF can inspect IPv6 next header, flow direction, source
addresses, and a range of IPv6 addresses for IPv6 packets. address(es), and destination address(es)
3. The NSF can inspect an exact port number and a range of port 3. The NSF can inspect the port number(s) and flow direction for the
numbers for the transport layer (TCP and UDP). transport layer protocol, i.e., TCP and UDP.
4. The NSF can control whether the packets are allowed to pass, 4. The NSF can control whether the packets are allowed to pass,
drop, or alert. drop, or mirror.
A.2. Example 2: Registration for the Capabilities of a Time-based A.2. Example 2: Registration for the Capabilities of a Time-based
Firewall Firewall
This section shows a configuration example for the capabilities This section shows a configuration example for the capabilities
registration of a time-based firewall in either an IPv4 network or an registration of a time-based firewall in either an IPv4 network or an
IPv6 network. IPv6 network.
<nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability"> <nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-name>time_based_firewall</nsf-name> <nsf-name>time_based_firewall</nsf-name>
<time-capabilities>absolute-time</time-capabilities> <event-capabilities>
<time-capabilities>periodic-time</time-capabilities> <time-capabilities>absolute-time</time-capabilities>
<condition-capabilities> <time-capabilities>periodic-time</time-capabilities>
<generic-nsf-capabilities> </event-capabilities>
<ipv4-capability>ipv4-protocol</ipv4-capability> <condition-capabilities>
<ipv4-capability>prefix-ipv4-address-flow-direction</ipv4-capability> <generic-nsf-capabilities>
<ipv4-capability>prefix-ipv4-address</ipv4-capability> <ipv4-capability>ipv4-protocol</ipv4-capability>
<ipv4-capability>range-ipv4-address-flow-direction</ipv4-capability> <ipv4-capability>flow-direction</ipv4-capability>
<ipv4-capability>range-ipv4-address</ipv4-capability> <ipv4-capability>source-address</ipv4-capability>
</generic-nsf-capabilities> <ipv4-capability>destination-address</ipv4-capability>
</condition-capabilities> </generic-nsf-capabilities>
<action-capabilities> </condition-capabilities>
<ingress-action-capability>pass</ingress-action-capability> <action-capabilities>
<ingress-action-capability>drop</ingress-action-capability> <ingress-action-capability>pass</ingress-action-capability>
<ingress-action-capability>alert</ingress-action-capability> <ingress-action-capability>drop</ingress-action-capability>
<egress-action-capability>pass</egress-action-capability> <ingress-action-capability>mirror</ingress-action-capability>
<egress-action-capability>drop</egress-action-capability> <egress-action-capability>pass</egress-action-capability>
<egress-action-capability>alert</egress-action-capability> <egress-action-capability>drop</egress-action-capability>
</action-capabilities> <egress-action-capability>mirror</egress-action-capability>
</nsf> </action-capabilities>
</nsf>
Figure 6: Configuration XML for the Capabilities Registration of a Figure 6: Configuration XML for the Capabilities Registration of
Time-based Firewall in an IPv4 Network a Time-based Firewall in an IPv4 Network
Figure 6 shows the configuration XML for the capabilities Figure 6 shows the configuration XML for the capabilities
registration of a time-based firewall as an NSF in an IPv4 network. registration of a time-based firewall as an NSF in an IPv4 network.
Its capabilities are as follows. Its capabilities are as follows.
1. The name of the NSF is time_based_firewall. 1. The name of the NSF is time_based_firewall.
2. The NSF can execute the security policy rule according to 2. The NSF can execute the security policy rule according to
absolute time and periodic time. absolute time and periodic time.
3. The NSF can inspect a protocol (Next-Header), an exact IPv4 3. The NSF can inspect the IPv4 protocol header field, flow
address, and a range of IPv4 addresses for IPv4 packets. direction, source address(es), and destination address(es).
4. The NSF can control whether the packets are allowed to pass, 4. The NSF can control whether the packets are allowed to pass,
drop, or alert. drop, or mirror.
<nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability"> <nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-name>time_based_firewall</nsf-name> <nsf-name>time_based_firewall</nsf-name>
<time-capabilities>absolute-time</time-capabilities> <event-capabilities>
<time-capabilities>periodic-time</time-capabilities> <time-capabilities>absolute-time</time-capabilities>
<condition-capabilities> <time-capabilities>periodic-time</time-capabilities>
<generic-nsf-capabilities> </event-capabilities>
<ipv6-capability>ipv6-next-header</ipv6-capability> <condition-capabilities>
<ipv6-capability>prefix-ipv6-address-flow-direction</ipv6-capability> <generic-nsf-capabilities>
<ipv6-capability>prefix-ipv6-address</ipv6-capability> <ipv6-capability>next-header</ipv6-capability>
<ipv6-capability>range-ipv6-address-flow-direction</ipv6-capability> <ipv6-capability>flow-direction</ipv6-capability>
<ipv6-capability>range-ipv6-address</ipv6-capability> <ipv6-capability>source-address</ipv6-capability>
</generic-nsf-capabilities> <ipv6-capability>destination-address</ipv6-capability>
</condition-capabilities> </generic-nsf-capabilities>
<action-capabilities> </condition-capabilities>
<ingress-action-capability>pass</ingress-action-capability> <action-capabilities>
<ingress-action-capability>drop</ingress-action-capability> <ingress-action-capability>pass</ingress-action-capability>
<ingress-action-capability>alert</ingress-action-capability> <ingress-action-capability>drop</ingress-action-capability>
<egress-action-capability>pass</egress-action-capability> <ingress-action-capability>mirror</ingress-action-capability>
<egress-action-capability>drop</egress-action-capability> <egress-action-capability>pass</egress-action-capability>
<egress-action-capability>alert</egress-action-capability> <egress-action-capability>drop</egress-action-capability>
</action-capabilities> <egress-action-capability>mirror</egress-action-capability>
</nsf> </action-capabilities>
</nsf>
Figure 7: Configuration XML for the Capabilities Registration of a Figure 7: Configuration XML for the Capabilities Registration of
Time-based Firewall in an IPv6 Network a Time-based Firewall in an IPv6 Network
In addition, Figure 7 shows the configuration XML for the In addition, Figure 7 shows the configuration XML for the
capabilities registration of a time-based firewall as an NSF in an capabilities registration of a time-based firewall as an NSF in an
IPv6 network. Its capabilities are as follows. IPv6 network. Its capabilities are as follows.
1. The name of the NSF is time_based_firewall. 1. The name of the NSF is time_based_firewall.
2. The NSF can execute the security policy rule according to 2. The NSF can execute the security policy rule according to
absolute time and periodic time. absolute time and periodic time.
3. The NSF can inspect a protocol (Next-Header), an exact IPv6 3. The NSF can inspect the IPv6 protocol header field, flow
address, and a range of IPv6 addresses for IPv6 packets. direction, source address(es), and destination address(es).
4. The NSF can control whether the packets are allowed to pass, 4. The NSF can control whether the packets are allowed to pass,
drop, or alert. drop, or mirror.
A.3. Example 3: Registration for the Capabilities of a Web Filter A.3. Example 3: Registration for the Capabilities of a Web Filter
This section shows a configuration example for the capabilities This section shows a configuration example for the capabilities
registration of a web filter. registration of a web filter.
<nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability"> <nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-name>web_filter</nsf-name> <nsf-name>web_filter</nsf-name>
<condition-capabilities> <condition-capabilities>
<advanced-nsf-capabilities> <advanced-nsf-capabilities>
<url-capability>user-defined</url-capability> <url-capability>user-defined</url-capability>
</advanced-nsf-capabilities> </advanced-nsf-capabilities>
</condition-capabilities> </condition-capabilities>
<action-capabilities> <action-capabilities>
<ingress-action-capability>pass</ingress-action-capability> <ingress-action-capability>pass</ingress-action-capability>
<ingress-action-capability>drop</ingress-action-capability> <ingress-action-capability>drop</ingress-action-capability>
<ingress-action-capability>alert</ingress-action-capability> <ingress-action-capability>mirror</ingress-action-capability>
<egress-action-capability>pass</egress-action-capability> <egress-action-capability>pass</egress-action-capability>
<egress-action-capability>drop</egress-action-capability> <egress-action-capability>drop</egress-action-capability>
<egress-action-capability>alert</egress-action-capability> <egress-action-capability>mirror</egress-action-capability>
</action-capabilities> </action-capabilities>
</nsf> </nsf>
Figure 8: Configuration XML for the Capabilities Registration of a Figure 8: Configuration XML for the Capabilities Registration of
Web Filter a Web Filter
Figure 8 shows the configuration XML for the capabilities Figure 8 shows the configuration XML for the capabilities
registration of a web filter as an NSF. Its capabilities are as registration of a web filter as an NSF. Its capabilities are as
follows. follows.
1. The name of the NSF is web_filter. 1. The name of the NSF is web_filter.
2. The NSF can inspect a URL matched from a user-defined URL 2. The NSF can inspect a URL matched from a user-defined URL. User
Database. User can add the new URL to the database. can specify their own URL.
3. The NSF can control whether the packets are allowed to pass, 3. The NSF can control whether the packets are allowed to pass,
drop, or alert. drop, or mirror.
A.4. Example 4: Registration for the Capabilities of a VoIP/VoLTE A.4. Example 4: Registration for the Capabilities of a VoIP/VoLTE
Filter Filter
This section shows a configuration example for the capabilities This section shows a configuration example for the capabilities
registration of a VoIP/VoLTE filter. registration of a VoIP/VoLTE filter.
<nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability"> <nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-name>voip_volte_filter</nsf-name> <nsf-name>voip_volte_filter</nsf-name>
<condition-capabilities> <condition-capabilities>
<advanced-nsf-capabilities> <advanced-nsf-capabilities>
<voip-volte-capability>voip-volte-call-id</voip-volte-capability> <voip-volte-capability>call-id</voip-volte-capability>
</advanced-nsf-capabilities> </advanced-nsf-capabilities>
</condition-capabilities> </condition-capabilities>
<action-capabilities> <action-capabilities>
<ingress-action-capability>pass</ingress-action-capability> <ingress-action-capability>pass</ingress-action-capability>
<ingress-action-capability>drop</ingress-action-capability> <ingress-action-capability>drop</ingress-action-capability>
<ingress-action-capability>alert</ingress-action-capability> <ingress-action-capability>mirror</ingress-action-capability>
<egress-action-capability>pass</egress-action-capability> <egress-action-capability>pass</egress-action-capability>
<egress-action-capability>drop</egress-action-capability> <egress-action-capability>drop</egress-action-capability>
<egress-action-capability>alert</egress-action-capability> <egress-action-capability>mirror</egress-action-capability>
</action-capabilities> </action-capabilities>
</nsf> </nsf>
Figure 9: Configuration XML for the Capabilities Registration of a Figure 9: Configuration XML for the Capabilities Registration of
VoIP/VoLTE Filter a VoIP/VoLTE Filter
Figure 9 shows the configuration XML for the capabilities Figure 9 shows the configuration XML for the capabilities
registration of a VoIP/VoLTE filter as an NSF. Its capabilities are registration of a VoIP/VoLTE filter as an NSF. Its capabilities are
as follows. as follows.
1. The name of the NSF is voip_volte_filter. 1. The name of the NSF is voip_volte_filter.
2. The NSF can inspect a voice call id for VoIP/VoLTE packets. 2. The NSF can inspect a voice call id for VoIP/VoLTE packets.
3. The NSF can control whether the packets are allowed to pass, 3. The NSF can control whether the packets are allowed to pass,
drop, or alert. drop, or mirror.
A.5. Example 5: Registration for the Capabilities of a HTTP and HTTPS A.5. Example 5: Registration for the Capabilities of a HTTP and HTTPS
Flood Mitigator Flood Mitigator
This section shows a configuration example for the capabilities This section shows a configuration example for the capabilities
registration of a HTTP and HTTPS flood mitigator. registration of a HTTP and HTTPS flood mitigator.
<nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability"> <nsf xmlns="urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability">
<nsf-name>http_and_https_flood_mitigation</nsf-name> <nsf-name>DDoS_mitigator</nsf-name>
<condition-capabilities> <condition-capabilities>
<advanced-nsf-capabilities> <advanced-nsf-capabilities>
<anti-ddos-capability>http-flood-action</anti-ddos-capability> <anti-ddos-capability>packet-rate</anti-ddos-capability>
<anti-ddos-capability>https-flood-action</anti-ddos-capability> <anti-ddos-capability>byte-rate</anti-ddos-capability>
<anti-ddos-capability>flow-rate</anti-ddos-capability>
</advanced-nsf-capabilities> </advanced-nsf-capabilities>
</condition-capabilities> </condition-capabilities>
<action-capabilities> <action-capabilities>
<ingress-action-capability>pass</ingress-action-capability> <ingress-action-capability>pass</ingress-action-capability>
<ingress-action-capability>drop</ingress-action-capability> <ingress-action-capability>drop</ingress-action-capability>
<ingress-action-capability>alert</ingress-action-capability> <ingress-action-capability>mirror</ingress-action-capability>
<egress-action-capability>pass</egress-action-capability> <egress-action-capability>pass</egress-action-capability>
<egress-action-capability>drop</egress-action-capability> <egress-action-capability>drop</egress-action-capability>
<egress-action-capability>alert</egress-action-capability> <egress-action-capability>mirror</egress-action-capability>
</action-capabilities> </action-capabilities>
</nsf> </nsf>
Figure 10: Configuration XML for the Capabilities Registration of a Figure 10: Configuration XML for the Capabilities Registration of
HTTP and HTTPS Flood Mitigator a HTTP and HTTPS Flood Mitigator
Figure 10 shows the configuration XML for the capabilities Figure 10 shows the configuration XML for the capabilities
registration of a HTTP and HTTPS flood mitigator as an NSF. Its registration of a HTTP and HTTPS flood mitigator as an NSF. Its
capabilities are as follows. capabilities are as follows.
1. The name of the NSF is http_and_https_flood_mitigation. 1. The name of the NSF is DDoS_mitigator.
2. The NSF can control the amount of packets for HTTP and HTTPS 2. The NSF can detect the amount of packet, flow, and byte rate in
packets, which are routed to the NSF's IPv4 address or the NSF's the network for potential DDoS Attack.
IPv6 address.
3. The NSF can control whether the packets are allowed to pass, 3. The NSF can control whether the packets are allowed to pass,
drop, or alert. drop, or mirror.
Appendix B. Acknowledgments Appendix B. Acknowledgments
This work was supported by Institute of Information & Communications This work was supported by Institute of Information & Communications
Technology Planning & Evaluation (IITP) grant funded by the Korea Technology Planning & Evaluation (IITP) grant funded by the Korea
MSIT (Ministry of Science and ICT) (R-20160222-002755, Cloud based MSIT (Ministry of Science and ICT) (R-20160222-002755, Cloud based
Security Intelligence Technology Development for the Customized Security Intelligence Technology Development for the Customized
Security Service Provisioning). This work was supported in part by Security Service Provisioning). This work was supported in part by
the IITP grant funded by the MSIT (2020-0-00395, Standard Development the IITP grant funded by the MSIT (2020-0-00395, Standard Development
of Blockchain based Network Management Automation Technology). of Blockchain based Network Management Automation Technology).
Appendix C. Contributors Appendix C. Contributors
This document is made by the group effort of I2NSF working group. This document is made by the group effort of I2NSF working group.
Many people actively contributed to this document, such as Acee Many people actively contributed to this document, such as Acee
Lindem, Roman Danyliw, and Tom Petch. The authors sincerely Lindem, Roman Danyliw, and Tom Petch. The authors sincerely
appreciate their contributions. appreciate their contributions.
The following are co-authors of this document: The following are co-authors of this document:
Patrick Lingga Patrick Lingga Department of Electrical and Computer Engineering
Department of Computer Science and Engineering Sungkyunkwan University 2066 Seo-ro Jangan-gu Suwon, Gyeonggi-do
Sungkyunkwan University 16419 Republic of Korea EMail: patricklink@skku.edu
2066 Seo-ro Jangan-gu
Suwon, Gyeonggi-do 16419
Republic of Korea
EMail: patricklink@skku.edu
Liang Xia
Huawei
101 Software Avenue
Nanjing, Jiangsu 210012
China
Liang Xia Huawei 101 Software Avenue Nanjing, Jiangsu 210012 China
EMail: Frank.Xialiang@huawei.com EMail: Frank.Xialiang@huawei.com
Cataldo Basile Cataldo Basile Politecnico di Torino Corso Duca degli Abruzzi, 34
Politecnico di Torino Torino, 10129 Italy EMail: cataldo.basile@polito.it
Corso Duca degli Abruzzi, 34
Torino, 10129
Italy
EMail: cataldo.basile@polito.it
John Strassner
Huawei
2330 Central Expressway
Santa Clara, CA 95050
USA
EMail: John.sc.Strassner@huawei.com
Diego R. Lopez John Strassner Huawei 2330 Central Expressway Santa Clara, CA 95050
Telefonica I+D USA EMail: John.sc.Strassner@huawei.com
Zurbaran, 12
Madrid, 28010
Spain
Diego R. Lopez Telefonica I+D Zurbaran, 12 Madrid, 28010 Spain
Email: diego.r.lopez@telefonica.com Email: diego.r.lopez@telefonica.com
Hyoungshick Kim Hyoungshick Kim Department of Computer Science and Engineering
Department of Computer Science and Engineering Sungkyunkwan University 2066 Seo-ro Jangan-gu Suwon, Gyeonggi-do
Sungkyunkwan University 16419 Republic of Korea EMail: hyoung@skku.edu
2066 Seo-ro Jangan-gu
Suwon, Gyeonggi-do 16419
Republic of Korea
EMail: hyoung@skku.edu
Daeyoung Hyun
Department of Computer Science and Engineering
Sungkyunkwan University
2066 Seo-ro Jangan-gu
Suwon, Gyeonggi-do 16419
Republic of Korea
EMail: dyhyun@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
Jung-Soo Park
Electronics and Telecommunications Research Institute
218 Gajeong-Ro, Yuseong-Gu
Daejeon, 34129
Republic of Korea
EMail: pjs@etri.re.kr Daeyoung Hyun Department of Computer Science and Engineering
Sungkyunkwan University 2066 Seo-ro Jangan-gu Suwon, Gyeonggi-do
16419 Republic of Korea EMail: dyhyun@skku.edu
Tae-Jin Ahn Dongjin Hong Department of Electronic, Electrical and Computer
Korea Telecom Engineering Sungkyunkwan University 2066 Seo-ro Jangan-gu Suwon,
70 Yuseong-Ro, Yuseong-Gu Gyeonggi-do 16419 Republic of Korea EMail: dong.jin@skku.edu
Daejeon, 305-811
Republic of Korea
EMail: taejin.ahn@kt.com Jung-Soo Park Electronics and Telecommunications Research Institute
218 Gajeong-Ro, Yuseong-Gu Daejeon, 34129 Republic of Korea EMail:
pjs@etri.re.kr
Se-Hui Lee Tae-Jin Ahn Korea Telecom 70 Yuseong-Ro, Yuseong-Gu Daejeon, 305-811
Korea Telecom Republic of Korea EMail: taejin.ahn@kt.com
70 Yuseong-Ro, Yuseong-Gu
Daejeon, 305-811
Republic of Korea
EMail: sehuilee@kt.com Se-Hui Lee Korea Telecom 70 Yuseong-Ro, Yuseong-Gu Daejeon, 305-811
Republic of Korea EMail: sehuilee@kt.com
Authors' Addresses Authors' Addresses
Susan Hares (editor) Susan Hares (editor)
Huawei Huawei
7453 Hickory Hill 7453 Hickory Hill
Saline, MI 48176 Saline, MI 48176
USA United States of America
Phone: +1-734-604-0332 Phone: +1-734-604-0332
EMail: shares@ndzh.com Email: shares@ndzh.com
Jaehoon (Paul) Jeong (editor) Jaehoon (Paul) Jeong (editor)
Department of Computer Science and Engineering Department of Computer Science and Engineering
Sungkyunkwan University Sungkyunkwan University
2066 Seobu-Ro, Jangan-Gu 2066 Seobu-Ro, Jangan-Gu
Suwon, Gyeonggi-Do 16419 Suwon
Gyeonggi-Do
16419
Republic of Korea Republic of Korea
Phone: +82 31 299 4957 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 URI: http://iotlab.skku.edu/people-jaehoon-jeong.php
Jinyong (Tim) Kim Jinyong (Tim) Kim
Department of Electronic, Electrical and Computer Engineering Department of Electronic, Electrical and Computer Engineering
Sungkyunkwan University Sungkyunkwan University
2066 Seobu-Ro, Jangan-Gu 2066 Seobu-Ro, Jangan-Gu
Suwon, Gyeonggi-Do 16419 Suwon
Gyeonggi-Do
16419
Republic of Korea Republic of Korea
Phone: +82 10 8273 0930 Phone: +82 10 8273 0930
EMail: timkim@skku.edu Email: timkim@skku.edu
Robert Moskowitz Robert Moskowitz
HTT Consulting HTT Consulting
Oak Park, MI Oak Park, MI
USA United States of America
Phone: +1-248-968-9809 Phone: +1-248-968-9809
EMail: rgm@htt-consult.com Email: rgm@htt-consult.com
Qiushi Lin Qiushi Lin
Huawei Huawei
Huawei Industrial Base Huawei Industrial Base
Shenzhen, Guangdong 518129 Shenzhen
Guangdong 518129,
China China
EMail: linqiushi@huawei.com Email: linqiushi@huawei.com
 End of changes. 364 change blocks. 
2505 lines changed or deleted 1983 lines changed or added

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