idnits 2.17.1 draft-ietf-i2nsf-capability-data-model-32.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == There are 2 instances of lines with non-ascii characters in the document. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (23 May 2022) is 703 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) ** Downref: Normative reference to an Informational RFC: RFC 3022 ** Downref: Normative reference to an Informational RFC: RFC 4766 ** Obsolete normative reference: RFC 6691 (Obsoleted by RFC 9293) ** Downref: Normative reference to an Informational RFC: RFC 8329 ** Downref: Normative reference to an Informational RFC: RFC 8805 -- Possible downref: Normative reference to a draft: ref. 'I-D.ietf-httpbis-messaging' -- Possible downref: Normative reference to a draft: ref. 'I-D.ietf-httpbis-semantics' == Outdated reference: A later version (-29) exists of draft-ietf-i2nsf-nsf-facing-interface-dm-27 == Outdated reference: A later version (-20) exists of draft-ietf-i2nsf-nsf-monitoring-data-model-18 == Outdated reference: A later version (-26) exists of draft-ietf-i2nsf-registration-interface-dm-16 -- Possible downref: Normative reference to a draft: ref. 'I-D.ietf-tcpm-rfc793bis' == Outdated reference: A later version (-28) exists of draft-ietf-tcpm-accurate-ecn-18 == Outdated reference: A later version (-32) exists of draft-ietf-tsvwg-udp-options-18 Summary: 5 errors (**), 0 flaws (~~), 7 warnings (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 I2NSF Working Group S. Hares, Ed. 3 Internet-Draft Huawei 4 Intended status: Standards Track J. Jeong, Ed. 5 Expires: 24 November 2022 J. Kim 6 Sungkyunkwan University 7 R. Moskowitz 8 HTT Consulting 9 Q. Lin 10 Huawei 11 23 May 2022 13 I2NSF Capability YANG Data Model 14 draft-ietf-i2nsf-capability-data-model-32 16 Abstract 18 This document defines an information model and the corresponding YANG 19 data model for the capabilities of various Network Security Functions 20 (NSFs) in the Interface to Network Security Functions (I2NSF) 21 framework to centrally manage the capabilities of the various NSFs. 23 Status of This Memo 25 This Internet-Draft is submitted in full conformance with the 26 provisions of BCP 78 and BCP 79. 28 Internet-Drafts are working documents of the Internet Engineering 29 Task Force (IETF). Note that other groups may also distribute 30 working documents as Internet-Drafts. The list of current Internet- 31 Drafts is at https://datatracker.ietf.org/drafts/current/. 33 Internet-Drafts are draft documents valid for a maximum of six months 34 and may be updated, replaced, or obsoleted by other documents at any 35 time. It is inappropriate to use Internet-Drafts as reference 36 material or to cite them other than as "work in progress." 38 This Internet-Draft will expire on 24 November 2022. 40 Copyright Notice 42 Copyright (c) 2022 IETF Trust and the persons identified as the 43 document authors. All rights reserved. 45 This document is subject to BCP 78 and the IETF Trust's Legal 46 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 47 license-info) in effect on the date of publication of this document. 48 Please review these documents carefully, as they describe your rights 49 and restrictions with respect to this document. Code Components 50 extracted from this document must include Revised BSD License text as 51 described in Section 4.e of the Trust Legal Provisions and are 52 provided without warranty as described in the Revised BSD License. 54 Table of Contents 56 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 57 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 4 58 3. Requirements of I2NSF NSF Capability . . . . . . . . . . . . 4 59 3.1. Design Principles and ECA Policy Model . . . . . . . . . 5 60 3.2. Conflict, Resolution Strategy and Default Action . . . . 9 61 4. Overview of YANG Data Model . . . . . . . . . . . . . . . . . 11 62 5. YANG Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 13 63 5.1. Network Security Function (NSF) Capabilities . . . . . . 13 64 6. YANG Data Model of I2NSF NSF Capability . . . . . . . . . . . 17 65 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 54 66 8. Privacy Considerations . . . . . . . . . . . . . . . . . . . 54 67 9. Security Considerations . . . . . . . . . . . . . . . . . . . 55 68 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 56 69 10.1. Normative References . . . . . . . . . . . . . . . . . . 56 70 10.2. Informative References . . . . . . . . . . . . . . . . . 62 71 Appendix A. Configuration Examples . . . . . . . . . . . . . . . 63 72 A.1. Example 1: Registration for the Capabilities of a General 73 Firewall . . . . . . . . . . . . . . . . . . . . . . . . 63 74 A.2. Example 2: Registration for the Capabilities of a 75 Time-based Firewall . . . . . . . . . . . . . . . . . . . 65 76 A.3. Example 3: Registration for the Capabilities of a Web 77 Filter . . . . . . . . . . . . . . . . . . . . . . . . . 67 78 A.4. Example 4: Registration for the Capabilities of a VoIP/VoCN 79 Filter . . . . . . . . . . . . . . . . . . . . . . . . . 68 80 A.5. Example 5: Registration for the Capabilities of an HTTP and 81 HTTPS Flood Mitigator . . . . . . . . . . . . . . . . . . 69 82 Appendix B. Acknowledgments . . . . . . . . . . . . . . . . . . 70 83 Appendix C. Contributors . . . . . . . . . . . . . . . . . . . . 71 84 Appendix D. Changes from 85 draft-ietf-i2nsf-capability-data-model-31 . . . . . . . . 72 86 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 72 88 1. Introduction 90 As the industry becomes more sophisticated and network devices (e.g., 91 Internet-of-Things (IoT) devices, autonomous vehicles, and 92 smartphones using Voice over Internet Protocol (VoIP) and Voice over 93 Cellular Network, such as LTE and 5G (VoCN)) require advanced 94 security protection in various scenarios, security service providers 95 have a lot of problems described in [RFC8192] to provide such network 96 devices with efficient and reliable security services in network 97 infrastructure. To resolve these problems, this document specifies 98 the information and data models of the capabilities of Network 99 Security Functions (NSFs) in a framework of the Interface to Network 100 Security Functions (I2NSF) [RFC8329]. 102 NSFs produced by multiple security vendors provide various security 103 capabilities to customers. Multiple NSFs can be combined to provide 104 security services over the given network traffic, regardless of 105 whether the NSFs are implemented as physical or virtual functions. 106 Security Capabilities describe the functions that Network Security 107 Functions (NSFs) can provide for security policy enforcement. 108 Security Capabilities are independent of the actual security policy 109 that will implement the functionality of the NSF. 111 Every NSF should be described with the set of capabilities it offers. 112 Security Capabilities enable security functionality to be described 113 in a vendor-neutral manner. Security Capabilities are a market 114 enabler, providing a way to define customized security protection by 115 unambiguously describing the security features offered by a given 116 NSF. Note that this YANG data model forms the basis of the NSF 117 Monitoring Interface YANG data model 118 [I-D.ietf-i2nsf-nsf-monitoring-data-model] and the NSF-Facing 119 Interface YANG data model [I-D.ietf-i2nsf-nsf-facing-interface-dm]. 121 This document provides an information model and the corresponding 122 YANG data model [RFC6020][RFC7950] that defines the capabilities of 123 NSFs to centrally manage the capabilities of those NSFs. The NSFs 124 can register their own capabilities into a Network Operator 125 Management (Mgmt) System (i.e., Security Controller) with this YANG 126 data model through the registration interface [RFC8329]. With the 127 database of the capabilities of those NSFs that are maintained 128 centrally, those NSFs can be more easily managed [RFC8329]. 130 This YANG data model uses an "Event-Condition-Action" (ECA) policy 131 model that is used as the basis for the design of I2NSF Policy as 132 described in [RFC8329] and Section 3.1. This policy model is not 133 entirely perfect in which a conflict may happen between the 134 configured policies, thus the YANG data model also provides an 135 additional element of conflict resolution as described in 136 Section 3.2. The "ietf-i2nsf-capability" YANG module defined in this 137 document provides the following features: 139 * Definition for event capabilities of network security functions. 141 * Definition for condition capabilities of network security 142 functions. 144 * Definition for action capabilities of network security functions. 146 * Definition for resolution strategy capabilities of network 147 security functions. 149 * Definition for default action capabilities of network security 150 functions. 152 2. Terminology 154 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 155 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 156 "OPTIONAL" in this document are to be interpreted as described in BCP 157 14 [RFC2119] [RFC8174] when, and only when, they appear in all 158 capitals, as shown here. 160 This document uses the terminology described in [RFC8329]. 162 This document follows the guidelines of [RFC8407], uses the common 163 YANG types defined in [RFC6991], and adopts the Network Management 164 Datastore Architecture (NMDA) [RFC8342]. The meaning of the symbols 165 in tree diagrams is defined in [RFC8340]. 167 3. Requirements of I2NSF NSF Capability 169 This section provides the I2NSF Capability Information Model (CapIM). 170 A CapIM is a formalization of the functionality that an NSF 171 advertises. This enables the precise specification of what an NSF 172 can do in terms of security policy enforcement, so that computer- 173 based tasks can unambiguously refer to, use, configure, and manage 174 NSFs. Capabilities are defined in a vendor- and technology- 175 independent manner (i.e., regardless of the differences among vendors 176 and individual products). 178 Network security experts can refer to categories of security controls 179 and understand each other. For instance, network security experts 180 agree on what is meant by the terms "NAT", "filtering", and "VPN 181 concentrator". As a further example, network security experts 182 unequivocally refer to "packet filters" as devices that allow or deny 183 packet forwarding based on various conditions (e.g., source and 184 destination IP addresses, source and destination ports, and IP 185 protocol type fields) [Alshaer]. 187 However, more information is required in case of other devices, like 188 stateful firewalls or application layer filters. These devices 189 filter packets or communications, but there are differences in the 190 packets and communications that they can categorize and the states 191 they maintain. Network engineers deal with these differences by 192 asking more questions to determine the specific category and 193 functionality of the device. Machines can follow a similar approach, 194 which is commonly referred to as question-answering [Hirschman]. In 195 this context, the CapIM and the derived data model can provide 196 important and rich information sources. 198 Analogous considerations can be applied for channel protection 199 protocols, where we all understand that they will protect packets by 200 means of symmetric algorithms whose keys could have been negotiated 201 with asymmetric cryptography, but they may work at different layers 202 and support different algorithms and protocols. To ensure 203 protection, these protocols apply integrity, optionally 204 confidentiality, anti-reply protections, and authentication. 206 The CapIM is intended to clarify these ambiguities by providing a 207 formal description of NSF functionality. The set of functions that 208 are advertised MAY be restricted according to the privileges of the 209 user or application that is viewing those functions. I2NSF 210 Capabilities enable unambiguous specification of the security 211 capabilities available in a (virtualized) networking environment, and 212 their automatic processing by means of computer-based techniques. 214 This CapIM enables a security controller in an I2NSF framework 215 [RFC8329] to properly identify and manage NSFs, and allow NSFs to 216 properly declare their functionality through a Developer's Management 217 System (DMS) [RFC8329], so that they can be used in the correct way. 219 3.1. Design Principles and ECA Policy Model 221 This document defines an information model for representing NSF 222 capabilities. Some basic design principles for security capabilities 223 and the systems that manage them are: 225 * Independence: Each security capability (e.g., events, conditions, 226 and actions) SHOULD be an independent function, with minimum 227 overlap or dependency on other capabilities. This enables each 228 security capability to be utilized and assembled with other 229 security capabilities together freely. More importantly, changes 230 to one capability SHOULD NOT affect other capabilities. This 231 follows the Single Responsibility Principle [Martin] [OODSRP]. 233 * Abstraction: Each capability MUST be defined in a vendor- 234 independent manner. 236 * Advertisement: The Registration Interface 237 [I-D.ietf-i2nsf-registration-interface-dm] MUST be used to 238 advertise and register the capabilities of each NSF. This same 239 interface MUST be used by other I2NSF Components to determine what 240 Capabilities are currently available to them. 242 * Execution: The NSF-Facing Interface 243 [I-D.ietf-i2nsf-nsf-facing-interface-dm] and NSF Monitoring 244 Interface [I-D.ietf-i2nsf-nsf-monitoring-data-model] MUST be used 245 to configure the use of a capability into an NSF and monitor the 246 NSF, respectively. These provide a standardized ability to 247 describe its functionality, and report its processing results, 248 respectively. These facilitate multivendor interoperability. 250 * Automation: The system MUST have the ability to auto-discover, 251 auto-negotiate, and auto-update the information of an NSF's 252 registered security capabilities without human intervention. 253 These features are especially useful for the management of a large 254 number of NSFs. They are essential for adding smart services 255 (e.g., refinement, analysis, capability reasoning, and 256 optimization) to the security scheme employed. These features are 257 supported by many design patterns, including the Observer Pattern 258 [OODOP], the Mediator Pattern [OODMP], and a set of Message 259 Exchange Patterns [Hohpe]. The Registration Interface 260 [I-D.ietf-i2nsf-registration-interface-dm] can register the 261 capabilities of NSFs with the security controller from the request 262 of a Developer's Management System, providing a list of available 263 NSFs, the corresponding security capabilities, and access 264 information to the security controller. Also, this interface can 265 send a query to Developer's Management System in order to find an 266 NSF to satisfy the requested security capability from the security 267 controller that receives a security policy. 269 * Scalability: The management system SHOULD have the capability to 270 scale up/down or scale in/out. Thus, it can meet various 271 performance requirements derived from changeable network traffic 272 or service requests. In addition, security capabilities that are 273 affected by scalability changes SHOULD support reporting 274 statistics to the security controller to assist its decision on 275 whether it needs to invoke scaling or not. The NSF Monitoring 276 Interface [I-D.ietf-i2nsf-nsf-monitoring-data-model] can observe 277 the performance of NSFs to let the security controller decide 278 scalability changes of the NSFs. 280 Based on the above principles, this document defines a capability 281 model that enables an NSF to register (and hence advertise) its set 282 of capabilities that other I2NSF Components can use. These 283 capabilities MUST have their access control restricted by a policy 284 and the mechanism of access control is RECOMMENDED to follow the 285 mechanism described in Network Configuration Access Control Model 286 (NACM) [RFC8341]; the policy that determines which components are 287 granted which access is out of scope for this document. The set of 288 capabilities provided by a given set of NSFs defines the security 289 services offered by the set of NSFs used. The security controller 290 can compare the requirements of users and applications with the set 291 of capabilities that are currently available in order to choose which 292 capabilities of which NSFs are needed to meet those requirements. 293 Note that this choice is independent of vendor, and instead relies 294 specifically on the capabilities (i.e., the description) of the 295 functions provided. 297 Furthermore, NSFs are subject to the updates of security capabilities 298 and software to cope with newly found security attacks or threats, 299 hence new capabilities may be created, and/or existing capabilities 300 may be updated (e.g., by updating its signature and algorithm). New 301 capabilities may be sent to and stored in a centralized repository, 302 or stored separately in a vendor's local repository. In either case, 303 the Registration Interface can facilitate this update process so the 304 Developer's Management System can let the security controller update 305 its repository for NSFs and their security capabilities. 307 The "Event-Condition-Action" (ECA) policy model in [RFC8329] is used 308 as the basis for the design of the capability model; The following 309 three terms define the structure and behavior of an I2NSF imperative 310 policy rule: 312 * Event: An Event is defined as any important occurrence in time of 313 a change in the system being managed, and/or in the environment of 314 the system being managed. When used in the context of I2NSF 315 Policy Rules, it is used to determine whether the condition clause 316 of an I2NSF Policy Rule can be evaluated or not. Examples of an 317 I2NSF Event include time and user actions (e.g., logon, logoff, 318 and actions that violate an ACL). 320 * Condition: A condition is defined as a set of attributes, 321 features, and/or values that are to be compared with a set of 322 known attributes, features, and/or values in order to determine 323 whether the set of actions in that (imperative) I2NSF Policy Rule 324 can be executed or not. Examples of I2NSF conditions include 325 matching attributes of a packet or flow, and comparing the 326 internal state of an NSF with a desired state. 328 * Action: An action is used to control and monitor aspects of NSFs 329 to handle packets or flows when the event and condition clauses 330 are satisfied. NSFs provide security functions by executing 331 various Actions. Examples of I2NSF actions include providing 332 intrusion detection and/or protection, web filtering (i.e., URL 333 filtering) and flow filtering, and deep packet inspection for 334 packets and flows. 336 An I2NSF Policy Rule is made up of three clauses: an Event clause, a 337 Condition clause, and an Action clause. This structure is also 338 called an ECA (Event-Condition-Action) Policy Rule. A Boolean clause 339 is a logical statement that evaluates to either TRUE or FALSE. It 340 may be made up of one or more terms; if more than one term is 341 present, then each term in the Boolean clause is combined using 342 logical connectives (i.e., AND, OR, and NOT). 344 An I2NSF ECA Policy Rule has the following semantics: 346 IF is TRUE 348 IF is TRUE 350 THEN execute [constrained by metadata] 352 END-IF 354 END-IF 356 Technically, the "Policy Rule" is really a container that aggregates 357 the above three clauses, as well as metadata which describe the 358 characteristics and behaviors of a capability (or an NSF). One 359 example of metadata that has been well-associated with a network 360 access control list is priority. Priority information is usually 361 given to a rule as a numerical value to control the execution order 362 of the rules. Associating a priority value an ECA policy enables a 363 business logic to be used to prescribe a behavior. For example, 364 suppose that a particular ECA Policy Rule contains three actions (A1, 365 A2, and A3 in order). Action A2 has a priority of 10; actions A1 and 366 A3 have no priority specified. Then, metadata may be used to 367 restrict the set of actions that can be executed when the event and 368 condition clauses of this ECA Policy Rule are evaluated to be TRUE; 369 two examples are: (1) only the first action (A1) is executed, and 370 then the policy rule returns to its caller, or (2) all actions are 371 executed, starting with the highest priority. 373 The above ECA policy model is very general and easily extensible. 375 For example, when an NSF has both url filtering capability and packet 376 filtering capability for protocol headers, it means that it can match 377 the URL as well as the Ethernet header, IP header, and Transport 378 header for packet filtering. The condition capability for url 379 filtering and packet filtering is not tightly linked to the action 380 capability due to the independence of our ECA design principle. The 381 action capability only lists the type of action that the NSF can take 382 to handle the matched packets. 384 3.2. Conflict, Resolution Strategy and Default Action 386 Formally, two I2NSF Policy Rules conflict with each other if: 388 * the Event Clauses of each evaluate to TRUE; 390 * the Condition Clauses of each evaluate to TRUE; 392 * the Action Clauses affect the same object in different ways. 394 For example, if we have two Policy Rules called R1 and R2 in the same 395 Policy: 397 R1: During 8am-6pm, if traffic is external, then run through 398 firewall 400 R2: During 7am-8pm, run antivirus 402 There is no conflict between the two policy rules R1 and R2, since 403 the policy rules act on different conditions, where firewall verifies 404 the packet header while antivirus verifies the contents. However, 405 consider these two rules called R3 and R4: 407 R3: During 9am-6pm, allow John to access social networking service 408 websites 410 R4: During 9am-6pm, disallow all users to access social networking 411 service websites 413 The two policy rules R3 and R4 are now in conflict, between the hours 414 of 9am and 6pm, because the actions of R3 and R4 are different and 415 apply to the same user (i.e., John). 417 Conflicts theoretically compromise the correct functioning of 418 devices. However, NSFs have been designed to cope with these issues. 419 Since conflicts are originated by simultaneously matching rules, an 420 additional process decides the action to be applied, e.g., among the 421 actions which the matching rule would have enforced. This process is 422 described by means of a resolution strategy for conflicts. The 423 finding and handling of conflicted matching rules is performed by 424 resolution strategies. 426 Some concrete examples of a resolution strategy are: 428 * First Matching Rule (FMR) 430 * Last Matching Rule (LMR) 431 * Prioritized Matching Rule (PMR) with Errors (PMRE) 433 * Prioritized Matching Rule with No Errors (PMRN) 435 In the above, a PMR strategy is defined as follows: 437 1. Order all actions by their Priority (highest is first, no 438 priority is last); actions that have the same priority may be 439 appear in any order in their relative location. 441 2. For PMRE: if any action fails to execute properly, temporarily 442 stop the execution of all actions. Invoke the error handler of 443 the failed action. If the error handler is able to recover from 444 the error, then continue the execution of any remaining actions; 445 else, terminate the execution of the ECA Policy Rule having those 446 all actions. 448 3. For PMRN: if any action fails to execute properly, stop the 449 execution of all actions. Invoke the error handler of the failed 450 action, but regardless of the result, the execution of the ECA 451 Policy Rule having those all actions MUST be terminated. 453 On the other hand, it may happen that, if an event is caught, none of 454 the policy rules matches the condition. Note that a packet or flow 455 is handled only when it matches both the event and condition of a 456 policy rule according to the ECA policy model. As a simple case, no 457 condition in the rules may match a packet arriving at the border 458 firewall. In this case, the packet is usually dropped, that is, the 459 firewall has a default behavior of packet dropping in order to manage 460 the cases that are not covered by specific rules. 462 Therefore, this document introduces two further capabilities for an 463 NSF to handle security policy conflicts with resolution strategies 464 and enforce a default action if no rules match. 466 * Resolution Strategies: They can be used to specify how to resolve 467 conflicts that occur between the actions of the similar or 468 different policy rules that are matched and contained in this 469 particular NSF; note that a badly written policy rule may cause a 470 conflict of actions with another similar policy rule. 472 * Default Action: It provides the default behavior to be executed 473 when there are no other alternatives. This action can be either 474 an explicit action or a set of actions. 476 4. Overview of YANG Data Model 478 This section provides an overview of how the YANG data model can be 479 used in the I2NSF framework described in [RFC8329]. Figure 1 shows 480 the capabilities (e.g., firewall and web filter) of NSFs in the I2NSF 481 Framework. As shown in this figure, a Developer's Management System 482 (DMS) can register NSFs and their capabilities with a Security 483 Controller. To register NSFs in this way, the DMS utilizes the 484 standardized capability YANG data model in this document through the 485 I2NSF Registration Interface [RFC8329]. That is, this Registration 486 Interface uses the YANG module described in this document to describe 487 the capabilities of an NSF that is registered with the Security 488 Controller. As described in [RFC8192], with the usage of the 489 Registration Interface and the YANG module in this document, the 490 capabilities registration of NSFs manufactured by multiple vendors 491 can be done together by the Security Controller in a centralized way, 492 and the information of the registered Capabilities in the Security 493 Controller information should be updated dynamically by each vendor 494 as the NSF may have software or hardware updates. 496 In Figure 1, a new NSF at a Developer's Management System has 497 capabilities of Firewall (FW) and Web Filter (WF), which are denoted 498 as (Cap = {FW, WF}), to support Event-Condition-Action (ECA) policy 499 rules where 'E', 'C', and 'A' mean "Event", "Condition", and 500 "Action", respectively. The condition involves IPv4 or IPv6 501 datagrams, and the action includes "Allow" and "Deny" for those 502 datagrams. Note that "E = {}" means that the event boolean will 503 always evaluate to true. 505 Note that the NSF-Facing Interface [RFC8329] is used by the Security 506 Controller to configure the security policy rules of NSFs (e.g., 507 firewall and Distributed Denial-of-Service (DDoS) attack mitigator) 508 with the capabilities of the NSFs registered with the Security 509 Controller. 511 +------------------------------------------------------+ 512 | I2NSF User (e.g., Overlay Network Mgmt, Enterprise | 513 | Network Mgmt, another network domain's mgmt, etc.) | 514 +--------------------+---------------------------------+ 515 I2NSF ^ 516 Consumer-Facing Interface| 517 | 518 v I2NSF 519 +-----------------+------------+ Registration +-------------+ 520 | Network Operator Mgmt System | Interface | Developer's | 521 | (i.e., Security Controller) |<------------>| Mgmt System | 522 +-----------------+------------+ +-------------+ 523 ^ New NSF 524 | Cap = {FW, WF} 525 I2NSF | E = {} 526 NSF-Facing Interface | C = {IPv4, IPv6} 527 | A = {Allow, Deny} 528 v 529 +---------------+----+------------+-----------------+ 530 | | | | 531 +---+---+ +---+---+ +---+---+ +---+---+ 532 | NSF-1 | ... | NSF-m | | NSF-1 | ... | NSF-n | 533 +-------+ +-------+ +-------+ +-------+ 534 NSF-1 NSF-m NSF-1 NSF-n 535 Cap = {FW, WF} Cap = {FW, WF} Cap = {FW, WF} Cap = {FW, WF} 536 E = {} E = {user} E = {dev} E = {} 537 C = {IPv4} C = {IPv6} C = {IPv4, IPv6} C = {IPv4, time} 538 A = {Allow,Deny} A = {Allow,Deny} A = {Allow,Deny} A = {Allow,Deny} 540 Developer's Mgmt System A Developer's Mgmt System B 542 Figure 1: Capabilities of NSFs in I2NSF Framework 544 A use case of an NSF with the capabilities of firewall and web filter 545 is described as follows. 547 * If a network administrator wants to apply security policy rules to 548 block malicious users with firewall and web filter, it is a 549 tremendous burden for a network administrator to apply all of the 550 needed rules to NSFs one by one. This problem can be resolved by 551 managing the capabilities of NSFs as described in this document. 553 * If a network administrator wants to block IPv4 or IPv6 packets 554 from malicious users, the network administrator sends a security 555 policy rule to the Network Operator Management System (i.e., 556 Security Controller) using the I2NSF Consumer-Facing Interface, 557 directing the system to block the users in question. 559 * When the Network Operator Management System receives the security 560 policy rule, it automatically sends that security policy rule to 561 appropriate NSFs (i.e., NSF-m in Developer's Management System A 562 and NSF-1 in Developer's Management System B) which can support 563 the capabilities (i.e., IPv6). This lets an I2NSF User not 564 consider which specific NSF(s) will work for the security policy 565 rule. 567 * If NSFs encounter the suspicious IPv4 or IPv6 packets of malicious 568 users, they can filter the packets out according to the configured 569 security policy rule. Therefore, the security policy rule against 570 the malicious users' packets can be automatically applied to 571 appropriate NSFs without human intervention. 573 5. YANG Tree Diagram 575 This section shows a YANG tree diagram of capabilities of network 576 security functions, as defined in the Section 3. 578 5.1. Network Security Function (NSF) Capabilities 580 This section explains a YANG tree diagram of NSF capabilities and its 581 features. Figure 2 shows a YANG tree diagram of NSF capabilities. 582 The NSF capabilities in the tree include directional capabilities, 583 event capabilities, condition capabilities, action capabilities, 584 resolution strategy capabilities, and default action capabilities. 585 Those capabilities can be tailored or extended according to a 586 vendor's specific requirements. Refer to the NSF capabilities 587 information model for detailed discussion in Section 3. 589 module: ietf-i2nsf-capability 590 +--rw nsf* [nsf-name] 591 +--rw nsf-name string 592 +--rw directional-capabilities* identityref 593 +--rw event-capabilities 594 | +--rw system-event-capability* identityref 595 | +--rw system-alarm-capability* identityref 596 +--rw condition-capabilities 597 | +--rw generic-nsf-capabilities 598 | | +--rw ethernet-capability* identityref 599 | | +--rw ipv4-capability* identityref 600 | | +--rw ipv6-capability* identityref 601 | | +--rw icmpv4-capability* identityref 602 | | +--rw icmpv6-capability* identityref 603 | | +--rw tcp-capability* identityref 604 | | +--rw udp-capability* identityref 605 | | +--rw sctp-capability* identityref 606 | | +--rw dccp-capability* identityref 607 | +--rw advanced-nsf-capabilities 608 | | +--rw anti-ddos-capability* identityref 609 | | +--rw ips-capability* identityref 610 | | +--rw anti-virus-capability* identityref 611 | | +--rw url-filtering-capability* identityref 612 | | +--rw voip-vocn-filtering-capability* identityref 613 | +--rw context-capabilities 614 | +--rw time-capabilities* identityref 615 | +--rw application-filter-capabilities* identityref 616 | +--rw device-type-capabilities* identityref 617 | +--rw user-condition-capabilities* identityref 618 | +--rw geographic-capabilities* identityref 619 +--rw action-capabilities 620 | +--rw ingress-action-capability* identityref 621 | +--rw egress-action-capability* identityref 622 | +--rw log-action-capability* identityref 623 +--rw resolution-strategy-capabilities* identityref 624 +--rw default-action-capabilities* identityref 626 Figure 2: YANG Tree Diagram of Capabilities of Network Security 627 Functions 629 The data model in this document provides identities for the 630 capabilities of NSFs. Every identity in the data model represents 631 the capability of an NSF. Each identity is explained in the 632 description of the identity. 634 Event capabilities are used to specify the capabilities that describe 635 an event that would trigger the evaluation of the condition clause of 636 the I2NSF Policy Rule. The defined event capabilities are system 637 event and system alarm. 639 Condition capabilities are used to specify capabilities of a set of 640 attributes, features, and/or values that are to be compared with a 641 set of known attributes, features, and/or values in order to 642 determine whether a set of actions needs to be executed or not so 643 that an imperative I2NSF policy rule can be executed. In this 644 document, two kinds of condition capabilities are used to classify 645 different capabilities of NSFs such as generic-nsf-capabilities and 646 advanced-nsf-capabilities. First, the generic-nsf-capabilities 647 define NSFs that operate on packet header for layer 2 (i.e., Ethernet 648 capability), layer 3 (i.e., IPv4 capability, IPv6 capability, ICMPv4 649 capability, and ICMPv6 capability.), and layer 4 (i.e., TCP 650 capability, UDP capability, SCTP capability, and DCCP capability). 651 Second, the advanced-nsf-capabilities define NSFs that operate on 652 features different from the generic-nsf-capabilities, e.g., the 653 payload, cross flow state, application layer, traffic statistics, 654 network behavior, etc. This document defines the advanced-nsf into 655 two categories such as content-security-control and attack- 656 mitigation-control. 658 * Content security control is an NSF that evaluates the payload of a 659 packet, such as Intrusion Prevention System (IPS), URL-Filtering, 660 Antivirus, and VoIP (Voice over Internet Protocol) / VoCN (Voice 661 over Cellular Network) Filter. 663 * Attack mitigation control is an NSF that mitigates an attack such 664 as anti-DDoS (DDoS-mitigator). 666 The advanced-nsf can be extended with other types of NSFs. This 667 document only provides five advanced-nsf capabilities, i.e., IPS 668 capability, URL-Filtering capability, Antivirus capability, VoIP/VoCN 669 Filter capability, and Anti-DDoS capability. Note that VoIP and VoCN 670 are merged into a single capability in this document because VoIP and 671 VoCN use the Session Initiation Protocol (SIP) [RFC3261] for a call 672 setup. See Section 3.1 for more information about the condition in 673 the ECA policy model. Also note that QUIC protocol [RFC9000] is 674 excluded in the data model as it is not considered in the initial 675 I2NSF documents [RFC8329]. The QUIC traffic should not be treated as 676 UDP traffic and will be considered in the future I2NSF documents. 678 The context capabilities provide extra information for the condition. 679 The given context conditions are application filter, target, user 680 condition, and geographic location. Time capabilities are used to 681 specify the capabilities which describe when to execute the I2NSF 682 policy rule. The time capabilities are defined in terms of absolute 683 time and periodic time, where the absolute time means the exact time 684 to start or end, and the periodic time means repeated time like day, 685 week, month, or year. The application filter capability is the 686 capability for matching the packet based on the application protocol, 687 such as HTTP, HTTPS, FTP, etc. The device type capability is the 688 capability for matching the type of the destination devices, such as 689 PC, IoT, Network Infrastructure devices, etc. The user condition is 690 the capability for matching the users of the network by mapping each 691 user ID to an IP address. Users can be combined into groups. The 692 geographic location capability is the capability for matching the 693 geographical location of a source or destination of a packet. 695 Note that due to the exclusion of QUIC protocol in the I2NSF 696 documents, HTTP/3 is also excluded in the document and will be 697 considered in the future I2NSF documents along with the QUIC 698 protocol. HTTP/3 should not be interpreted as either HTTP/1.1 or 699 HTTP/2. 701 Action capabilities are used to specify the capabilities that 702 describe the control and monitoring aspects of flow-based NSFs when 703 the event and condition clauses are satisfied. The action 704 capabilities are defined as ingress-action capability, egress-action 705 capability, and log-action capability. See Section 3.1 for more 706 information about the action in the ECA policy model. Also, see 707 Section 7.2 (NSF-Facing Flow Security Policy Structure) in [RFC8329] 708 for more information about the ingress and egress actions. In 709 addition, see Section 9.1 (Flow-Based NSF Capability 710 Characterization) in [RFC8329] and Section 6.5 (NSF Logs) in 711 [I-D.ietf-i2nsf-nsf-monitoring-data-model] for more information about 712 logging at NSFs. 714 Resolution strategy capabilities are used to specify the capabilities 715 that describe conflicts that occur between the actions of the similar 716 or different policy rules that are matched and contained in this 717 particular NSF; note that a badly written policy rule may cause a 718 conflict of actions with another similar policy rule. The resolution 719 strategy capabilities are defined as First Matching Rule (FMR), Last 720 Matching Rule (LMR), Prioritized Matching Rule with Error (PMRE), and 721 Prioritized Matching with No Errors (PMRN). See Section 3.2 for more 722 information about the resolution strategy. 724 Default action capabilities are used to specify the capabilities that 725 describe how to execute I2NSF policy rules when no rule matches a 726 packet. The default action capabilities are defined as pass, drop, 727 reject, rate-limit, and mirror. See Section 3.2 for more information 728 about the default action. 730 6. YANG Data Model of I2NSF NSF Capability 732 This section introduces a YANG module for NSFs' capabilities, as 733 defined in the Section 3. 735 It makes references to 737 * [RFC0768] 739 * [RFC0791] 741 * [RFC0792] 743 * [RFC0854] 745 * [RFC0959] 747 * [RFC1939] 749 * [RFC2474] 751 * [RFC2595] 753 * [RFC3022] 755 * [RFC3168] 757 * [RFC3261] 759 * [RFC4250] 761 * [RFC4340] 763 * [RFC4443] 765 * [RFC4766] 767 * [RFC5103] 769 * [RFC5321] 771 * [RFC5595] 773 * [RFC6335] 775 * [RFC6437] 777 * [RFC6691] 778 * [RFC6864] 780 * [RFC7323] 782 * [RFC8075] 784 * [RFC8200] 786 * [RFC8311] 788 * [RFC8329] 790 * [RFC8805] 792 * [RFC9051] 794 * [IEEE802.3-2018] 796 * [IANA-Protocol-Numbers] 798 * [I-D.ietf-httpbis-http2bis] 800 * [I-D.ietf-httpbis-messaging] 802 * [I-D.ietf-httpbis-semantics] 804 * [I-D.ietf-tcpm-rfc793bis] 806 * [I-D.ietf-tcpm-accurate-ecn] 808 * [I-D.ietf-tsvwg-rfc4960-bis] 810 * [I-D.ietf-tsvwg-udp-options] 812 * [I-D.ietf-i2nsf-nsf-monitoring-data-model] 814 file "ietf-i2nsf-capability@2022-05-23.yang" 815 module ietf-i2nsf-capability { 816 yang-version 1.1; 817 namespace 818 "urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability"; 819 prefix 820 i2nsfcap; 822 organization 823 "IETF I2NSF (Interface to Network Security Functions) 824 Working Group"; 826 contact 827 "WG Web: 828 WG List: 830 Editor: Susan Hares 831 833 Editor: Jaehoon (Paul) Jeong 834 836 Editor: Jinyong (Tim) Kim 837 839 Editor: Robert Moskowitz 840 842 Editor: Qiushi Lin 843 845 Editor: Patrick Lingga 846 "; 848 description 849 "This module is a YANG module for I2NSF Network Security 850 Functions (NSFs)'s Capabilities. 852 Copyright (c) 2022 IETF Trust and the persons identified as 853 authors of the code. All rights reserved. 855 Redistribution and use in source and binary forms, with or 856 without modification, is permitted pursuant to, and subject to 857 the license terms contained in, the Revised BSD License set 858 forth in Section 4.c of the IETF Trust's Legal Provisions 859 Relating to IETF Documents 860 (https://trustee.ietf.org/license-info). 862 This version of this YANG module is part of RFC XXXX 863 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself 864 for full legal notices."; 866 // RFC Ed.: replace XXXX with an actual RFC number and remove 867 // this note. 869 revision "2022-05-23"{ 870 description "Initial revision."; 871 reference 872 "RFC XXXX: I2NSF Capability YANG Data Model"; 874 // RFC Ed.: replace XXXX with an actual RFC number and remove 875 // this note. 876 } 878 /* 879 * Identities 880 */ 882 identity event { 883 description 884 "Base identity for I2NSF events."; 885 reference 886 "draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF NSF 887 Monitoring Interface YANG Data Model - Event"; 888 } 890 identity system-event { 891 base event; 892 description 893 "Base identity for system event. System event (also called 894 alert) is defined as a warning about any changes of 895 configuration, any access violation, the information of 896 sessions and traffic flows."; 897 reference 898 "draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF NSF 899 Monitoring Interface YANG Data Model - System event"; 900 } 902 identity system-alarm { 903 base event; 904 description 905 "Base identity for system alarm. System alarm is defined as a 906 warning related to service degradation in system hardware."; 907 reference 908 "draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF NSF 909 Monitoring Interface YANG Data Model - System alarm"; 910 } 912 identity access-violation { 913 base system-event; 914 description 915 "Identity for access violation event. Access-violation system 916 event is an event when a user tries to access (read, write, 917 create, or delete) any information or execute commands 918 above their privilege (i.e., not-conformant with the 919 access profile)."; 920 reference 921 "draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF NSF 922 Monitoring Interface YANG Data Model - System event for access 923 violation"; 924 } 926 identity configuration-change { 927 base system-event; 928 description 929 "Identity for configuration change event. Configuration change 930 is a system event when a new configuration is added or an 931 existing configuration is modified."; 932 reference 933 "draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF NSF 934 Monitoring Interface YANG Data Model - System event for 935 configuration change"; 936 } 938 identity memory-alarm { 939 base system-alarm; 940 description 941 "Memory is the hardware to store information temporarily or for 942 a short period, i.e., Random Access Memory (RAM). A 943 memory-alarm is emitted when the memory usage is exceeding 944 the threshold."; 945 reference 946 "draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF NSF 947 Monitoring Interface YANG Data Model - System alarm for 948 memory"; 949 } 951 identity cpu-alarm { 952 base system-alarm; 953 description 954 "CPU is the Central Processing Unit that executes basic 955 operations of the system. A cpu-alarm is emitted when the CPU 956 usage is exceeding a threshold."; 957 reference 958 "draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF NSF 959 Monitoring Interface YANG Data Model - System alarm for CPU"; 960 } 962 identity disk-alarm { 963 base system-alarm; 964 description 965 "Disk or storage is the hardware to store information for a 966 long period, i.e., Hard Disk and Solid-State Drive. A 967 disk-alarm is emitted when the disk usage is exceeding a 968 threshold."; 969 reference 970 "draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF NSF 971 Monitoring Interface YANG Data Model - System alarm for disk"; 972 } 974 identity hardware-alarm { 975 base system-alarm; 976 description 977 "A hardware alarm is emitted when a hardware failure (e.g., 978 CPU, memory, disk, or interface) is detected. A hardware 979 failure is a malfunction within the electronic circuits or 980 electromechanical components of the hardware that makes it 981 unusable."; 982 reference 983 "draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF NSF 984 Monitoring Interface YANG Data Model - System alarm for 985 hardware"; 986 } 988 identity interface-alarm { 989 base system-alarm; 990 description 991 "Interface is the network interface for connecting a device 992 with the network. The interface-alarm is emitted when the 993 state of the interface is changed."; 994 reference 995 "draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF NSF 996 Monitoring Interface YANG Data Model - System alarm for 997 interface"; 998 } 1000 identity time { 1001 description 1002 "Base identity for time capabilities"; 1003 } 1005 identity absolute-time { 1006 base time; 1007 description 1008 "absolute time capabilities. 1009 If a network security function has the absolute time 1010 capability, the network security function supports 1011 rule execution according to absolute time."; 1012 } 1014 identity periodic-time { 1015 base time; 1016 description 1017 "periodic time capabilities. 1019 If a network security function has the periodic time 1020 capability, the network security function supports 1021 rule execution according to periodic time."; 1022 } 1024 identity device-type { 1025 description 1026 "Base identity for device type condition capability. The 1027 capability for matching the source or destination device 1028 type."; 1029 } 1031 identity computer { 1032 base device-type; 1033 description 1034 "Identity for computer such as personal computer (PC) 1035 and server"; 1036 } 1038 identity mobile-phone { 1039 base device-type; 1040 description 1041 "Identity for mobile-phone such as smartphone and 1042 cellphone"; 1043 } 1045 identity voip-vocn-phone { 1046 base device-type; 1047 description 1048 "Identity for VoIP (Voice over Internet Protocol) or VoCN 1049 (Voice over Cellular Network, such as Voice over LTE or 5G) 1050 phone"; 1051 } 1053 identity tablet { 1054 base device-type; 1055 description 1056 "Identity for tablet"; 1057 } 1059 identity network-infrastructure-device { 1060 base device-type; 1061 description 1062 "Identity for network infrastructure devices 1063 such as switch, router, and access point"; 1064 } 1066 identity iot { 1067 base device-type; 1068 description 1069 "Identity for Internet of Things (IoT) devices 1070 such as sensors, actuators, and low-power 1071 low-capacity computing devices"; 1072 } 1074 identity ot { 1075 base device-type; 1076 description 1077 "Identity for Operational Technology (OT) devices (also 1078 known as industrial control systems) that interact 1079 with the physical environment and detect or cause direct 1080 change through the monitoring and control of devices, 1081 processes, and events such as programmable logic 1082 controllers (PLCs), digital oscilloscopes, building 1083 management systems (BMS), and fire control systems"; 1084 } 1086 identity vehicle { 1087 base device-type; 1088 description 1089 "Identity for transportation vehicles that connect to and 1090 share data through the Internet over Vehicle-to-Everything 1091 (V2X) communications."; 1092 } 1094 identity user-condition { 1095 description 1096 "Base identity for user condition capability. This is the 1097 capability of mapping user(s) into their corresponding IP 1098 address"; 1099 } 1101 identity user { 1102 base user-condition; 1103 description 1104 "Identity for user condition capability. 1105 A user (e.g., employee) can be mapped to an IP address of 1106 a computing device (e.g., computer, laptop, and virtual 1107 machine) which the user is using."; 1108 } 1110 identity group { 1111 base user-condition; 1112 description 1113 "Identity for group condition capability. 1114 A group (e.g., employees) can be mapped to multiple IP 1115 addresses of computing devices (e.g., computers, laptops, 1116 and virtual machines) which the group is using."; 1117 } 1119 identity geographic-location { 1120 description 1121 "Base identity for geographic location condition capability"; 1122 reference 1123 "RFC 8805: A Format for Self-Published IP Geolocation Feeds - 1124 An access control for a geographical location (i.e., 1125 geolocation) that has the corresponding IP prefix."; 1126 } 1128 identity source-location { 1129 base geographic-location; 1130 description 1131 "Identity for source geographic location condition capability"; 1132 reference 1133 "RFC 8805: A Format for Self-Published IP Geolocation Feeds - 1134 An access control for a geographical location (i.e., 1135 geolocation) that has the corresponding IP prefix."; 1136 } 1138 identity destination-location { 1139 base geographic-location; 1140 description 1141 "Identity for destination geographic location condition 1142 capability"; 1143 reference 1144 "RFC 8805: A Format for Self-Published IP Geolocation Feeds - 1145 An access control for a geographical location (i.e., 1146 geolocation) that has the corresponding IP prefix."; 1147 } 1149 identity directional { 1150 description 1151 "Base identity for directional traffic flow export capability"; 1152 reference 1153 "RFC 5103: Bidirectional Flow Export Using IP Flow Information 1154 Export (IPFIX) - Terminology Unidirectional and Bidirectional 1155 Flow"; 1156 } 1158 identity unidirectional { 1159 base directional; 1160 description 1161 "Identity for unidirectional traffic flow export."; 1162 reference 1163 "RFC 5103: Bidirectional Flow Export Using IP Flow Information 1164 Export (IPFIX) - Terminology Unidirectional Flow"; 1165 } 1167 identity bidirectional { 1168 base directional; 1169 description 1170 "Identity for bidirectional traffic flow export."; 1171 reference 1172 "RFC 5103: Bidirectional Flow Export Using IP Flow Information 1173 Export (IPFIX) - Terminology Bidirectional Flow"; 1174 } 1176 identity protocol { 1177 description 1178 "Base identity for protocols"; 1179 } 1181 identity ethernet { 1182 base protocol; 1183 description 1184 "Base identity for Ethernet protocol."; 1185 } 1187 identity source-mac-address { 1188 base ethernet; 1189 description 1190 "Identity for the capability of matching Media Access Control 1191 (MAC) source address(es) condition capability."; 1192 reference 1193 "IEEE 802.3 - 2018: IEEE Standard for Ethernet"; 1194 } 1196 identity destination-mac-address { 1197 base ethernet; 1198 description 1199 "Identity for the capability of matching Media Access Control 1200 (MAC) destination address(es) condition capability."; 1201 reference 1202 "IEEE 802.3 - 2018: IEEE Standard for Ethernet"; 1203 } 1205 identity ether-type { 1206 base ethernet; 1207 description 1208 "Identity for the capability of matching the EtherType in 1209 Ethernet II and Length in Ethernet 802.3 of a packet."; 1210 reference 1211 "IEEE 802.3 - 2018: IEEE Standard for Ethernet"; 1212 } 1214 identity ip { 1215 base protocol; 1216 description 1217 "Base identity for internet/network layer protocol, 1218 e.g., IPv4, IPv6, and ICMP."; 1219 } 1221 identity ipv4 { 1222 base ip; 1223 description 1224 "Base identity for IPv4 condition capability"; 1225 reference 1226 "RFC 791: Internet Protocol"; 1227 } 1229 identity ipv6 { 1230 base ip; 1231 description 1232 "Base identity for IPv6 condition capabilities"; 1233 reference 1234 "RFC 8200: Internet Protocol, Version 6 (IPv6) 1235 Specification"; 1236 } 1238 identity dscp { 1239 base ipv4; 1240 base ipv6; 1241 description 1242 "Identity for the capability of matching IPv4 annd IPv6 1243 Differentiated Services Codepoint (DSCP) condition"; 1244 reference 1245 "RFC 791: Internet Protocol - Type of Service 1246 RFC 2474: Definition of the Differentiated 1247 Services Field (DS Field) in the IPv4 and 1248 IPv6 Headers 1249 RFC 8200: Internet Protocol, Version 6 (IPv6) 1250 Specification - Traffic Class"; 1251 } 1253 identity ecn { 1254 base ipv4; 1255 base ipv6; 1256 description 1257 "Identity for the capability of matching IPv4 annd IPv6 1258 Explicit Congestion Notification (ECN) condition"; 1260 reference 1261 "RFC 3168: The Addition of Explicit Congestion 1262 Notification (ECN) to IP. 1263 RFC 8311: Relaxing Restrictions on Explicit Congestion 1264 Notification (ECN) Experimentation"; 1265 } 1267 identity total-length { 1268 base ipv4; 1269 base ipv6; 1270 description 1271 "Identity for the capability of matching IPv4 Total Length 1272 header field or IPv6 Payload Length header field. 1274 IPv4 Total Length is the length of datagram, measured in 1275 octets, including internet header and data. 1277 IPv6 Payload Length is the length of the IPv6 payload, i.e., 1278 the rest of the packet following the IPv6 header, measured in 1279 octets."; 1280 reference 1281 "RFC 791: Internet Protocol - Total Length 1282 RFC 8200: Internet Protocol, Version 6 (IPv6) 1283 Specification - Payload Length"; 1284 } 1286 identity ttl { 1287 base ipv4; 1288 base ipv6; 1289 description 1290 "Identity for the capability of matching IPv4 Time-To-Live 1291 (TTL) or IPv6 Hop Limit."; 1292 reference 1293 "RFC 791: Internet Protocol - Time To Live (TTL) 1294 RFC 8200: Internet Protocol, Version 6 (IPv6) 1295 Specification - Hop Limit"; 1296 } 1298 identity next-header { 1299 base ipv4; 1300 base ipv6; 1301 description 1302 "Identity for the capability of matching IPv4 Protocol field 1303 and IPv6 Next Header field. Note that IPv4 Protocol field is 1304 equivalent to IPv6 Next Header field."; 1305 reference 1306 "IANA Website: Assigned Internet Protocol Numbers 1307 - Protocol Numbers 1308 RFC 791: Internet Protocol - Protocol 1309 RFC 8200: Internet Protocol, Version 6 (IPv6) 1310 Specification - Next Header"; 1311 } 1313 identity source-address { 1314 base ipv4; 1315 base ipv6; 1316 description 1317 "Identity for the capability of matching IPv4 or IPv6 source 1318 address(es) condition capability."; 1319 reference 1320 "RFC 791: Internet Protocol - Address 1321 RFC 8200: Internet Protocol, Version 6 (IPv6) 1322 Specification - Source Address"; 1323 } 1325 identity destination-address { 1326 base ipv4; 1327 base ipv6; 1328 description 1329 "Identity for the capability of matching IPv4 or IPv6 1330 destination address(es) condition capability."; 1331 reference 1332 "RFC 791: Internet Protocol - Address 1333 RFC 8200: Internet Protocol, Version 6 (IPv6) 1334 Specification - Destination Address"; 1335 } 1337 identity flow-direction { 1338 base ipv4; 1339 base ipv6; 1340 description 1341 "Identity for flow direction of matching IPv4/IPv6 source 1342 or destination address(es) condition capability where a flow's 1343 direction is either unidirectional or bidirectional"; 1344 reference 1345 "RFC 791: Internet Protocol 1346 RFC 8200: Internet Protocol, Version 6 (IPv6) 1347 Specification"; 1348 } 1350 identity ihl { 1351 base ipv4; 1352 description 1353 "Identity for matching IPv4 header-length (IHL) 1354 condition capability"; 1355 reference 1356 "RFC 791: Internet Protocol - Header Length"; 1357 } 1359 identity identification { 1360 base ipv4; 1361 description 1362 "Identity for IPv4 identification condition capability. 1363 IPv4 ID field is used for fragmentation and reassembly."; 1364 reference 1365 "RFC 791: Internet Protocol - Identification 1366 RFC 6864: Updated Specification of the IPv4 ID Field - 1367 Fragmentation and Reassembly"; 1368 } 1370 identity fragment-offset { 1371 base ipv4; 1372 description 1373 "Identity for matching IPv4 fragment offset 1374 condition capability"; 1375 reference 1376 "RFC 791: Internet Protocol - Fragmentation Offset"; 1377 } 1379 identity flow-label { 1380 base ipv6; 1381 description 1382 "Identity for matching IPv6 flow label 1383 condition capability"; 1384 reference 1385 "RFC 8200: Internet Protocol, Version 6 (IPv6) 1386 Specification - Flow Label 1387 RFC 6437: IPv6 Flow Label Specification"; 1388 } 1390 identity transport-protocol { 1391 base protocol; 1392 description 1393 "Base identity for Layer 4 protocol condition capabilities, 1394 e.g., TCP, UDP, SCTP, and DCCP"; 1395 } 1397 identity tcp { 1398 base transport-protocol; 1399 description 1400 "Base identity for TCP condition capabilities"; 1401 reference 1402 "draft-ietf-tcpm-rfc793bis-25: Transmission Control Protocol 1403 (TCP) Specification"; 1405 } 1407 identity udp { 1408 base transport-protocol; 1409 description 1410 "Base identity for UDP condition capabilities"; 1411 reference 1412 "RFC 768: User Datagram Protocol"; 1413 } 1415 identity sctp { 1416 base transport-protocol; 1417 description 1418 "Base identity for SCTP condition capabilities"; 1419 reference 1420 "draft-ietf-tsvwg-rfc4960-bis-18: Stream Control Transmission 1421 Protocol"; 1422 } 1424 identity dccp { 1425 base transport-protocol; 1426 description 1427 "Base identity for DCCP condition capabilities"; 1428 reference 1429 "RFC 4340: Datagram Congestion Control Protocol"; 1430 } 1432 identity source-port-number { 1433 base tcp; 1434 base udp; 1435 base sctp; 1436 base dccp; 1437 description 1438 "Identity for matching TCP, UDP, SCTP, and DCCP source port 1439 number condition capability"; 1440 reference 1441 "draft-ietf-tcpm-rfc793bis-25: Transmission Control Protocol 1442 (TCP) Specification 1443 RFC 768: User Datagram Protocol 1444 draft-ietf-tsvwg-rfc4960-bis-18: Stream Control Transmission 1445 Protocol 1446 RFC 4340: Datagram Congestion Control Protocol"; 1447 } 1449 identity destination-port-number { 1450 base tcp; 1451 base udp; 1452 base sctp; 1453 base dccp; 1454 description 1455 "Identity for matching TCP, UDP, SCTP, and DCCP destination 1456 port number condition capability"; 1457 reference 1458 "draft-ietf-tcpm-rfc793bis-25: Transmission Control Protocol 1459 (TCP) Specification"; 1460 } 1462 identity flags { 1463 base ipv4; 1464 base tcp; 1465 description 1466 "Identity for IPv4 flags and TCP control bits (flags) condition 1467 capability. Note that this should not be interpreted such that 1468 IPv4 flags and TCP flags are similar. 1469 If this identity is used under 'ipv4-capability', it indicates 1470 the support of matching the IPv4 flags header. 1471 If this identity is used under 'tcp-capability', it indicates 1472 the support of matching the TCP control bits (flags) header. 1473 The IPv4 flags is the three-bit field in IPv4 header to 1474 control and identify fragments. 1475 The TCP flags is the multiple one-bit fields after the 1476 reserved field in TCP header that indicates the connection 1477 states or provides additional information."; 1478 reference 1479 "RFC 791: Internet Protocol - Flags 1480 draft-ietf-tcpm-rfc793bis-25: Transmission Control Protocol 1481 (TCP) Specification - TCP Header Flags 1482 RFC 3168: The Addition of Explicit Congestion Notification 1483 (ECN) to IP - ECN-Echo (ECE) Flag and Congestion Window 1484 Reduced (CWR) Flag 1485 draft-ietf-tcpm-accurate-ecn-15: More Accurate ECN Feedback 1486 in TCP - ECN-Echo (ECE) Flag and Congestion Window Reduced 1487 (CWR) Flag"; 1488 } 1490 identity options { 1491 base tcp; 1492 description 1493 "Identity for matching TCP options header field condition 1494 capability. When an NSF claims to have this capability, the 1495 NSF should be able to match the TCP options header field in 1496 binary."; 1497 reference 1498 "draft-ietf-tcpm-rfc793bis-25: Transmission Control Protocol 1499 (TCP) Specification 1500 RFC 6691: TCP Options and Maximum Segment Size 1501 RFC 7323: TCP Extensions for High Performance"; 1502 } 1504 identity data-offset { 1505 base tcp; 1506 base dccp; 1507 description 1508 "Identity for matching TCP and DCCP Data Offset condition 1509 capability. 1510 If this identity is used under 'tcp-capability', it indicates 1511 the support of matching the TCP data offset header. 1512 If this identity is used under 'sctp-capability', it indicates 1513 the support of matching the DCCP data offset header. 1514 The TCP Data Offset header field represents the size of the 1515 TCP header, expressed in 32-bit words. 1516 The DCCP Data Offset is the offset from the start of the 1517 packet's DCCP header to the start of its application data 1518 area, in 32-bit words."; 1519 reference 1520 "draft-ietf-tcpm-rfc793bis-25: Transmission Control Protocol 1521 (TCP) Specification - Data Offset 1522 RFC 4340: Datagram Congestion Control Protocol"; 1523 } 1525 identity reserved { 1526 base tcp; 1527 description 1528 "Identity for TCP header reserved field condition capability. 1529 The set of control bits reserved for future used. The control 1530 bits are also known as flags. Must be zero in generated 1531 segments and must be ignored in received segments, if 1532 corresponding future features are unimplemented by the 1533 sending or receiving host."; 1534 reference 1535 "draft-ietf-tcpm-rfc793bis-25: Transmission Control Protocol 1536 (TCP) Specification"; 1537 } 1539 identity window-size { 1540 base tcp; 1541 description 1542 "Identity for TCP header Window field condition capability. 1543 The number of data octets beginning with the one indicated 1544 in the acknowledgment field that the sender of this segment 1545 is willing to accept."; 1546 reference 1547 "draft-ietf-tcpm-rfc793bis-25: Transmission Control Protocol 1548 (TCP) Specification"; 1550 } 1552 identity urgent-pointer { 1553 base tcp; 1554 description 1555 "Identity for TCP Urgent Pointer header field condition 1556 capability. The Urgent Pointer field in TCP describes the 1557 current value of urgent pointer as a positive offset from 1558 the sequence number in this segment. The urgent pointer 1559 points to the sequence number of the octet following the 1560 urgent data. This field is only be interpreted in segments 1561 with the URG control bit set."; 1562 reference 1563 "draft-ietf-tcpm-rfc793bis-25: Transmission Control Protocol 1564 (TCP) Specification"; 1565 } 1567 identity length { 1568 base udp; 1569 base sctp; 1570 description 1571 "Identity for matching UDP length and SCTP chunk length 1572 condition capability. 1573 If this identity is used under 'udp-capability', it indicates 1574 the support of matching the UDP length header. 1575 If this identity is used under 'sctp-capability', it indicates 1576 the support of matching the SCTP chunk length header. 1577 The UDP length is the length in octets of this user datagram 1578 including this header and the datagram. The UDP length can be 1579 smaller than the IP transport length for UDP transport layer 1580 options. 1581 The SCTP chunk length represents the size of the chunk in 1582 bytes including the SCTP Chunk type, Chunk flags, Chunk flags, 1583 and Chunk Value fields."; 1584 reference 1585 "RFC 768: User Datagram Protocol - Length 1586 draft-ietf-tsvwg-udp-options: Transport Options for UDP 1587 draft-ietf-tsvwg-rfc4960-bis-18: Stream Control Transmission 1588 Protocol - Chunk Length"; 1589 } 1591 identity chunk-type { 1592 base sctp; 1593 description 1594 "Identity for SCTP chunk type condition capability"; 1595 reference 1596 "draft-ietf-tsvwg-rfc4960-bis-18: Stream Control Transmission 1597 Protocol - Chunk Type"; 1599 } 1601 identity service-code { 1602 base dccp; 1603 description 1604 "Identity for DCCP Service Code condition capability"; 1605 reference 1606 "RFC 4340: Datagram Congestion Control Protocol 1607 RFC 5595: The Datagram Congestion Control Protocol (DCCP) 1608 Service Codes 1609 RFC 6335: Internet Assigned Numbers Authority (IANA) 1610 Procedures for the Management of the Service Name and 1611 Transport Protocol Port Number Registry - Service Code"; 1612 } 1614 identity icmp { 1615 base protocol; 1616 description 1617 "Base identity for ICMPv4 and ICMPv6 condition capability"; 1618 reference 1619 "RFC 792: Internet Control Message Protocol 1620 RFC 4443: Internet Control Message Protocol (ICMPv6) 1621 for the Internet Protocol Version 6 (IPv6) Specification 1622 - ICMPv6"; 1623 } 1625 identity icmpv4 { 1626 base icmp; 1627 description 1628 "Base identity for ICMPv4 condition capability"; 1629 reference 1630 "RFC 792: Internet Control Message Protocol"; 1631 } 1633 identity icmpv6 { 1634 base icmp; 1635 description 1636 "Base identity for ICMPv6 condition capability"; 1637 reference 1638 "RFC 4443: Internet Control Message Protocol (ICMPv6) 1639 for the Internet Protocol Ver sion 6 (IPv6) Specification 1640 - ICMPv6"; 1641 } 1643 identity type { 1644 base icmpv4; 1645 base icmpv6; 1646 base dccp; 1647 description 1648 "Identity for ICMPv4, ICMPv6, and DCCP type condition 1649 capability"; 1650 reference 1651 "RFC 792: Internet Control Message Protocol 1652 RFC 4443: Internet Control Message Protocol (ICMPv6) 1653 for the Internet Protocol Version 6 (IPv6) Specification 1654 - ICMPv6 1655 RFC 4340: Datagram Congestion Control Protocol"; 1656 } 1658 identity code { 1659 base icmpv4; 1660 base icmpv6; 1661 description 1662 "Identity for ICMPv4 and ICMPv6 code condition capability"; 1663 reference 1664 "RFC 792: Internet Control Message Protocol 1665 RFC 4443: Internet Control Message Protocol (ICMPv6) 1666 for the Internet Protocol Version 6 (IPv6) Specification 1667 - ICMPv6"; 1668 } 1670 identity application-protocol { 1671 base protocol; 1672 description 1673 "Base identity for Application protocol. Note that a subset of 1674 application protocols (e.g., HTTP, HTTPS, FTP, POP3, and 1675 IMAP) are handled in this YANG module, rather than all 1676 the existing application protocols."; 1677 } 1679 identity http { 1680 base application-protocol; 1681 description 1682 "The identity for Hypertext Transfer Protocol version 1.1 1683 (HTTP/1.1)."; 1684 reference 1685 "draft-ietf-httpbis-semantics-19: HTTP Semantics 1686 draft-ietf-httpbis-messaging-19: HTTP/1.1"; 1687 } 1689 identity https { 1690 base application-protocol; 1691 description 1692 "The identity for Hypertext Transfer Protocol version 1.1 1693 (HTTP/1.1) over TLS."; 1694 reference 1695 "draft-ietf-httpbis-semantics-19: HTTP Semantics 1696 draft-ietf-httpbis-messaging-19: HTTP/1.1"; 1697 } 1699 identity http2 { 1700 base application-protocol; 1701 description 1702 "The identity for Hypertext Transfer Protocol version 2 1703 (HTTP/2)."; 1704 reference 1705 "draft-ietf-httpbis-http2bis-07: HTTP/2"; 1706 } 1708 identity https2 { 1709 base application-protocol; 1710 description 1711 "The identity for Hypertext Transfer Protocol version 2 1712 (HTTP/2) over TLS."; 1713 reference 1714 "draft-ietf-httpbis-http2bis-07: HTTP/2"; 1715 } 1717 identity ftp { 1718 base application-protocol; 1719 description 1720 "The identity for File Transfer Protocol."; 1721 reference 1722 "RFC 959: File Transfer Protocol (FTP)"; 1723 } 1725 identity ssh { 1726 base application-protocol; 1727 description 1728 "The identity for Secure Shell (SSH) protocol."; 1729 reference 1730 "RFC 4250: The Secure Shell (SSH) Protocol"; 1731 } 1733 identity telnet { 1734 base application-protocol; 1735 description 1736 "The identity for telnet."; 1737 reference 1738 "RFC 854: Telnet Protocol"; 1739 } 1741 identity smtp { 1742 base application-protocol; 1743 description 1744 "The identity for Simple Mail Transfer Protocol."; 1745 reference 1746 "RFC 5321: Simple Mail Transfer Protocol (SMTP)"; 1747 } 1749 identity pop3 { 1750 base application-protocol; 1751 description 1752 "The identity for Post Office Protocol 3 (POP3)."; 1753 reference 1754 "RFC 1939: Post Office Protocol - Version 3 (POP3)"; 1755 } 1757 identity pop3s { 1758 base application-protocol; 1759 description 1760 "The identity for Post Office Protocol 3 (POP3) over TLS"; 1761 reference 1762 "RFC 1939: Post Office Protocol - Version 3 (POP3) 1763 RFC 2595: Using TLS with IMAP, POP3 and ACAP"; 1764 } 1766 identity imap { 1767 base application-protocol; 1768 description 1769 "The identity for Internet Message Access Protocol (IMAP)."; 1770 reference 1771 "RFC 9051: Internet Message Access Protocol (IMAP) - Version 1772 4rev2"; 1773 } 1775 identity imaps { 1776 base application-protocol; 1777 description 1778 "The identity for Internet Message Access Protocol (IMAP) over 1779 TLS"; 1780 reference 1781 "RFC 9051: Internet Message Access Protocol (IMAP) - Version 1782 4rev2 1783 RFC 2595: Using TLS with IMAP, POP3 and ACAP"; 1784 } 1786 identity action { 1787 description 1788 "Base identity for action capability"; 1789 } 1790 identity log-action { 1791 base action; 1792 description 1793 "Base identity for log-action capability"; 1794 } 1796 identity ingress-action { 1797 base action; 1798 description 1799 "Base identity for ingress-action capability"; 1800 reference 1801 "RFC 8329: Framework for Interface to Network Security 1802 Functions - Section 7.2"; 1803 } 1805 identity egress-action { 1806 base action; 1807 description 1808 "Base identity for egress-action capability"; 1809 reference 1810 "RFC 8329: Framework for Interface to Network Security 1811 Functions - Section 7.2"; 1812 } 1814 identity default-action { 1815 base action; 1816 description 1817 "Base identity for default-action capability"; 1818 } 1820 identity rule-log { 1821 base log-action; 1822 description 1823 "Identity for rule log. Log the policy rule that has been 1824 triggered."; 1825 } 1827 identity session-log { 1828 base log-action; 1829 description 1830 "Identity for session log. A session is a connection (i.e., 1831 traffic flow) of a data plane that includes source and 1832 destination of IP addresses and transport port numbers with 1833 the protocol used. Log the session that triggered a policy 1834 rule."; 1835 } 1837 identity pass { 1838 base ingress-action; 1839 base egress-action; 1840 base default-action; 1841 description 1842 "Identity for pass action capability. The pass action allows 1843 packet or flow to go through the NSF entering or exiting the 1844 internal network."; 1845 } 1847 identity drop { 1848 base ingress-action; 1849 base egress-action; 1850 base default-action; 1851 description 1852 "Identity for drop action capability. The drop action denies 1853 a packet to go through the NSF entering or exiting the 1854 internal network without sending any response back to the 1855 source."; 1856 } 1858 identity reject { 1859 base ingress-action; 1860 base egress-action; 1861 base default-action; 1862 description 1863 "Identity for reject action capability. The reject action 1864 denies a packet to go through the NSF entering or exiting the 1865 internal network and sends a response back to the source. 1866 The response depends on the packet and implementation. 1867 For example, a TCP packet is rejected with TCP RST response 1868 or a UDP packet may be rejected with an ICMPv4 response 1869 message with Type 3 Code 3 or ICMPv6 response message 1870 Type 1 Code 4 (i.e., Destination Unreachable: Destination 1871 port unreachable) "; 1872 } 1874 identity mirror { 1875 base ingress-action; 1876 base egress-action; 1877 base default-action; 1878 description 1879 "Identity for mirror action capability. The mirror action 1880 copies packet and send it to the monitoring entity while still 1881 allow the packet or flow to go through the NSF."; 1882 } 1884 identity rate-limit { 1885 base ingress-action; 1886 base egress-action; 1887 base default-action; 1888 description 1889 "Identity for rate limiting action capability. The rate limit 1890 action limits the number of packets or flows that can go 1891 through the NSF by dropping packets or flows (randomly or 1892 systematically)."; 1893 } 1895 identity invoke-signaling { 1896 base egress-action; 1897 description 1898 "Identity for invoke signaling action capability. The invoke 1899 signaling action is used to convey information of the event 1900 triggering this action to a monitoring entity"; 1901 } 1903 identity tunnel-encapsulation { 1904 base egress-action; 1905 description 1906 "Identity for tunnel encapsulation action capability. The 1907 tunnel encapsulation action is used to encapsulate the packet 1908 to be tunneled across the network to enable a secure 1909 connection."; 1910 } 1912 identity forwarding { 1913 base egress-action; 1914 description 1915 "Identity for forwarding action capability. The forwarding 1916 action is used to relay the packet from one network segment 1917 to another node in the network."; 1918 } 1920 identity transformation { 1921 base egress-action; 1922 description 1923 "Identity for transformation action capability. The 1924 transformation action is used to transform a packet by 1925 modifying it (e.g., HTTP-to-CoAP packet translation). 1926 Note that a subset of transformation (e.g., HTTP-to-CoAP and 1927 Network Address Translator (NAT)) is handled in this YANG 1928 module, rather than all the existing transformations. 1929 Specific algorithmic transformations can be executed by a 1930 middlebox (e.g., NSF) for a given transformation 1931 name."; 1932 reference 1933 "RFC 8075: Guidelines for Mapping Implementations: HTTP to the 1934 Constrained Application Protocol (CoAP) - Translation between 1935 HTTP and CoAP 1936 RFC 3022: Traditional IP Network Address Translator 1937 (Traditional NAT)"; 1938 } 1940 identity http-to-coap { 1941 base transformation; 1942 description 1943 "Identity for HTTP-to-CoAP transformation action capability. 1944 This indicates the support of HTTP-to-CoAP packet 1945 translation."; 1946 reference 1947 "RFC 8075: Guidelines for Mapping Implementations: HTTP to the 1948 Constrained Application Protocol (CoAP) - Translation between 1949 HTTP and CoAP."; 1950 } 1952 identity nat { 1953 base transformation; 1954 description 1955 "Identity for Network Address Translation (NAT) transformation 1956 action capability. This indicates the support of NAT for 1957 network address mapping."; 1958 reference 1959 "RFC 3022: Traditional IP Network Address Translator 1960 (Traditional NAT)"; 1961 } 1963 identity resolution-strategy { 1964 description 1965 "Base identity for resolution strategy capability"; 1966 } 1968 identity fmr { 1969 base resolution-strategy; 1970 description 1971 "Identity for First Matching Rule (FMR) resolution 1972 strategy capability"; 1973 } 1975 identity lmr { 1976 base resolution-strategy; 1977 description 1978 "Identity for Last Matching Rule (LMR) resolution 1979 strategy capability"; 1980 } 1981 identity pmre { 1982 base resolution-strategy; 1983 description 1984 "Identity for Prioritized Matching Rule with Errors (PMRE) 1985 resolution strategy capability"; 1986 } 1988 identity pmrn { 1989 base resolution-strategy; 1990 description 1991 "Identity for Prioritized Matching Rule with No Errors (PMRN) 1992 resolution strategy capability"; 1993 } 1995 identity advanced-nsf { 1996 description 1997 "Base identity for advanced Network Security Function (NSF) 1998 capability."; 1999 } 2001 identity content-security-control { 2002 base advanced-nsf; 2003 description 2004 "Base identity for content security control. Content security 2005 control is an NSF that evaluates a packet's payload such as 2006 Intrusion Prevention System (IPS), URL-Filtering, Antivirus, 2007 and VoIP/CN Filter."; 2008 } 2010 identity attack-mitigation-control { 2011 base advanced-nsf; 2012 description 2013 "Base identity for attack mitigation control. Attack mitigation 2014 control is an NSF that mitigates an attack such as anti-DDoS 2015 or DDoS-mitigator."; 2016 } 2018 identity ips { 2019 base content-security-control; 2020 description 2021 "Base identity for IPS (Intrusion Prevention System) capability 2022 that prevents malicious activity within a network"; 2023 } 2025 identity url-filtering { 2026 base content-security-control; 2027 description 2028 "Base identity for url filtering capability that limits access 2029 by comparing the web traffic's URL with the URLs for web 2030 filtering in a database"; 2031 } 2033 identity anti-virus { 2034 base content-security-control; 2035 description 2036 "Base identity for antivirus capability to protect the network 2037 by detecting and removing viruses."; 2038 } 2040 identity voip-vocn-filtering { 2041 base content-security-control; 2042 description 2043 "Base identity for an advanced NSF for VoIP (Voice over 2044 Internet Protocol) and VoCN (Voice over Cellular Network, 2045 such as Voice over LTE or 5G) Security Service capability 2046 to filter the VoIP/VoCN packets or flows."; 2047 reference 2048 "RFC 3261: SIP: Session Initiation Protocol"; 2049 } 2051 identity anti-ddos { 2052 base attack-mitigation-control; 2053 description 2054 "Base identity for advanced NSF Anti-DDoS Attack or DDoS 2055 Mitigator capability."; 2056 } 2058 identity packet-rate { 2059 base anti-ddos; 2060 description 2061 "Identity for advanced NSF Anti-DDoS detecting Packet Rate 2062 Capability where a packet rate is defined as the arrival rate 2063 of Packets toward a victim destination node. The NSF with 2064 this capability can detect the incoming packet rate and create 2065 an alert if the rate exceeds the threshold."; 2067 } 2069 identity flow-rate { 2070 base anti-ddos; 2071 description 2072 "Identity for advanced NSF Anti-DDoS detecting Flow Rate 2073 Capability where a flow rate is defined as the arrival rate of 2074 flows towards a victim destination node. The NSF with this 2075 capability can detect the incoming flow rate and create an 2076 alert if the rate exceeds the threshold."; 2078 } 2080 identity byte-rate { 2081 base anti-ddos; 2082 description 2083 "Identity for advanced NSF Anti-DDoS detecting Byte Rate 2084 Capability where a byte rate is defined as the arrival rate of 2085 Bytes toward a victim destination node. The NSF with this 2086 capability can detect the incoming byte rate and create an 2087 alert if the rate exceeds the threshold."; 2088 } 2090 identity signature-set { 2091 base ips; 2092 description 2093 "Identity for the capability of IPS to set the signature. 2094 Signature is a set of rules to detect an intrusive activity."; 2095 reference 2096 "RFC 4766: Intrusion Detection Message Exchange Requirements - 2097 Section 2.2.13"; 2098 } 2100 identity exception-signature { 2101 base ips; 2102 description 2103 "Identity for the capability of IPS to exclude signatures from 2104 detecting the intrusion."; 2105 reference 2106 "RFC 4766: Intrusion Detection Message Exchange Requirements - 2107 Section 2.2.13"; 2108 } 2110 identity detect { 2111 base anti-virus; 2112 description 2113 "Identity for advanced NSF Antivirus capability to detect 2114 viruses using a security profile. The security profile is used 2115 to scan threats, such as virus, malware, and spyware. The NSF 2116 should be able to update the security profile."; 2117 } 2119 identity exception-files { 2120 base anti-virus; 2121 description 2122 "Identity for advanced NSF Antivirus capability to exclude a 2123 certain file type or name from detection."; 2124 } 2125 identity pre-defined { 2126 base url-filtering; 2127 description 2128 "Identity for pre-defined URL Database condition capability 2129 where URL database is a public database for URL filtering."; 2130 } 2132 identity user-defined { 2133 base url-filtering; 2134 description 2135 "Identity for user-defined URL Database condition capability 2136 that allows a user's manual addition of URLs for URL 2137 filtering."; 2138 } 2140 identity call-id { 2141 base voip-vocn-filtering; 2142 description 2143 "Identity for advanced NSF VoIP/VoCN Call Identifier (ID) 2144 capability."; 2145 } 2147 identity user-agent { 2148 base voip-vocn-filtering; 2149 description 2150 "Identity for advanced NSF VoIP/VoCN User Agent capability."; 2151 } 2153 /* 2154 * Grouping 2155 */ 2157 grouping nsf-capabilities { 2158 description 2159 "Network Security Function (NSF) Capabilities"; 2160 reference 2161 "RFC 8329: Framework for Interface to Network Security 2162 Functions - I2NSF Flow Security Policy Structure."; 2164 leaf-list directional-capabilities { 2165 type identityref { 2166 base directional; 2167 } 2168 description 2169 "The capability of an NSF for handling directional traffic 2170 flow (i.e., unidirectional or bidirectional traffic flow)."; 2171 } 2172 container event-capabilities { 2173 description 2174 "Capabilities of events. 2175 If a network security function has the event capabilities, 2176 the network security function supports rule execution 2177 according to system event and system alarm."; 2179 reference 2180 "RFC 8329: Framework for Interface to Network Security 2181 Functions - Section 7. 2182 draft-ietf-i2nsf-nsf-monitoring-data-model-19: I2NSF 2183 NSF Monitoring Interface YANG Data Model - System Alarm and 2184 System Events."; 2186 leaf-list system-event-capability { 2187 type identityref { 2188 base system-event; 2189 } 2190 description 2191 "System event capabilities"; 2192 } 2194 leaf-list system-alarm-capability { 2195 type identityref { 2196 base system-alarm; 2197 } 2198 description 2199 "System alarm capabilities"; 2200 } 2201 } 2203 container condition-capabilities { 2204 description 2205 "Conditions capabilities."; 2206 container generic-nsf-capabilities { 2207 description 2208 "Conditions capabilities. 2209 If a network security function has the condition 2210 capabilities, the network security function 2211 supports rule execution according to conditions of 2212 IPv4, IPv6, TCP, UDP, SCTP, DCCP, ICMP, or ICMPv6."; 2213 reference 2214 "RFC 768: User Datagram Protocol - UDP. 2215 RFC 791: Internet Protocol - IPv4. 2216 RFC 792: Internet Control Message Protocol - ICMP. 2217 RFC 4443: Internet Control Message Protocol (ICMPv6) 2218 for the Internet Protocol Version 6 (IPv6) Specification 2219 - ICMPv6. 2221 draft-ietf-tsvwg-rfc4960-bis-18: Stream Control 2222 Transmission Protocol - SCTP. 2223 RFC 8200: Internet Protocol, Version 6 (IPv6) 2224 Specification - IPv6. 2225 RFC 8329: Framework for Interface to Network Security 2226 Functions - I2NSF Flow Security Policy Structure. 2227 draft-ietf-tcpm-rfc793bis-25: Transmission Control 2228 Protocol (TCP) Specification"; 2230 leaf-list ethernet-capability { 2231 type identityref { 2232 base ethernet; 2233 } 2234 description 2235 "Media Access Control (MAC) capabilities"; 2236 reference 2237 "IEEE 802.3: IEEE Standard for Ethernet"; 2238 } 2240 leaf-list ipv4-capability { 2241 type identityref { 2242 base ipv4; 2243 } 2244 description 2245 "IPv4 packet capabilities"; 2246 reference 2247 "RFC 791: Internet Protocol"; 2248 } 2250 leaf-list ipv6-capability { 2251 type identityref { 2252 base ipv6; 2253 } 2254 description 2255 "IPv6 packet capabilities"; 2256 reference 2257 "RFC 8200: Internet Protocol, Version 6 (IPv6) 2258 Specification - IPv6"; 2259 } 2261 leaf-list icmpv4-capability { 2262 type identityref { 2263 base icmpv4; 2264 } 2265 description 2266 "ICMPv4 packet capabilities"; 2267 reference 2268 "RFC 792: Internet Control Message Protocol - ICMP"; 2270 } 2272 leaf-list icmpv6-capability { 2273 type identityref { 2274 base icmpv6; 2275 } 2276 description 2277 "ICMPv6 packet capabilities"; 2278 reference 2279 "RFC 4443: Internet Control Message Protocol (ICMPv6) 2280 for the Internet Protocol Version 6 (IPv6) Specification 2281 - ICMPv6"; 2282 } 2284 leaf-list tcp-capability { 2285 type identityref { 2286 base tcp; 2287 } 2288 description 2289 "TCP packet capabilities"; 2290 reference 2291 "draft-ietf-tcpm-rfc793bis-25: Transmission Control 2292 Protocol (TCP) Specification"; 2293 } 2295 leaf-list udp-capability { 2296 type identityref { 2297 base udp; 2298 } 2299 description 2300 "UDP packet capabilities"; 2301 reference 2302 "RFC 768: User Datagram Protocol - UDP"; 2303 } 2305 leaf-list sctp-capability { 2306 type identityref { 2307 base sctp; 2308 } 2309 description 2310 "SCTP packet capabilities"; 2311 reference 2312 "draft-ietf-tsvwg-rfc4960-bis-18: Stream Control 2313 Transmission Protocol - SCTP"; 2314 } 2316 leaf-list dccp-capability { 2317 type identityref { 2318 base dccp; 2319 } 2320 description 2321 "DCCP packet capabilities"; 2322 reference 2323 "RFC 4340: Datagram Congestion Control Protocol - DCCP"; 2324 } 2325 } 2327 container advanced-nsf-capabilities { 2328 description 2329 "Advanced Network Security Function (NSF) capabilities, 2330 such as Anti-DDoS, IPS, and VoIP/VoCN. 2331 This container contains the leaf-lists of advanced 2332 NSF capabilities"; 2334 leaf-list anti-ddos-capability { 2335 type identityref { 2336 base anti-ddos; 2337 } 2338 description 2339 "Anti-DDoS Attack capabilities"; 2340 } 2342 leaf-list ips-capability { 2343 type identityref { 2344 base ips; 2345 } 2346 description 2347 "IPS capabilities"; 2348 } 2350 leaf-list anti-virus-capability { 2351 type identityref { 2352 base anti-virus; 2353 } 2354 description 2355 "Antivirus capabilities"; 2356 } 2358 leaf-list url-filtering-capability { 2359 type identityref { 2360 base url-filtering; 2361 } 2362 description 2363 "URL Filtering capabilities"; 2364 } 2365 leaf-list voip-vocn-filtering-capability { 2366 type identityref { 2367 base voip-vocn-filtering; 2368 } 2369 description 2370 "VoIP/VoCN capabilities"; 2371 } 2372 } 2374 container context-capabilities { 2375 description 2376 "Security context capabilities"; 2378 leaf-list time-capabilities { 2379 type identityref { 2380 base time; 2381 } 2382 description 2383 "The capabilities for activating the policy within a 2384 specific time."; 2385 } 2387 leaf-list application-filter-capabilities{ 2388 type identityref { 2389 base application-protocol; 2390 } 2391 description 2392 "Context capabilities based on the application protocol"; 2393 } 2395 leaf-list device-type-capabilities { 2396 type identityref { 2397 base device-type; 2398 } 2399 description 2400 "Context capabilities based on the device attribute that 2401 can identify a device type 2402 (i.e., router, switch, pc, ios, or android)."; 2403 } 2405 leaf-list user-condition-capabilities { 2406 type identityref { 2407 base user-condition; 2408 } 2409 description 2410 "Context capabilities based on user condition, such as 2411 user-id and user-name. The users can be collected into a 2412 user group (i.e., a group of users) and identified with 2413 group-id or group-name. An NSF is aware of the IP 2414 address of the user provided by a unified user 2415 management system via network. Based on name-address 2416 association, an NSF is able to enforce the security 2417 functions over the given user (or user group)"; 2418 } 2420 leaf-list geographic-capabilities { 2421 type identityref { 2422 base geographic-location; 2423 } 2424 description 2425 "Context condition capabilities based on the geographical 2426 location of the source or destination"; 2427 } 2428 } 2429 } 2431 container action-capabilities { 2432 description 2433 "Action capabilities. 2434 If a network security function has the action capabilities, 2435 the network security function supports the attendant 2436 actions for policy rules."; 2438 leaf-list ingress-action-capability { 2439 type identityref { 2440 base ingress-action; 2441 } 2442 description 2443 "Ingress-action capabilities"; 2444 } 2446 leaf-list egress-action-capability { 2447 type identityref { 2448 base egress-action; 2449 } 2450 description 2451 "Egress-action capabilities"; 2452 } 2454 leaf-list log-action-capability { 2455 type identityref { 2456 base log-action; 2457 } 2458 description 2459 "Log-action capabilities"; 2460 } 2462 } 2464 leaf-list resolution-strategy-capabilities { 2465 type identityref { 2466 base resolution-strategy; 2467 } 2468 description 2469 "Resolution strategy capabilities. 2470 The resolution strategies can be used to specify how 2471 to resolve conflicts that occur between the actions 2472 of the similar or different policy rules that are matched 2473 for the same packet and by particular NSF; note that a 2474 badly written policy rule may cause a conflict of actions 2475 with another similar policy rule."; 2476 } 2478 leaf-list default-action-capabilities { 2479 type identityref { 2480 base default-action; 2481 } 2482 description 2483 "Default action capabilities. 2484 A default action is used to execute I2NSF policy rules 2485 when no rule matches a packet. The default action is 2486 defined as pass, drop, reject, rate-limit, or mirror."; 2487 } 2488 } 2490 /* 2491 * Data nodes 2492 */ 2494 list nsf { 2495 key "nsf-name"; 2496 description 2497 "The list of Network Security Functions (NSFs)"; 2498 leaf nsf-name { 2499 type string; 2500 mandatory true; 2501 description 2502 "The name of Network Security Function (NSF)"; 2503 } 2504 uses nsf-capabilities; 2505 } 2506 } 2507 2509 Figure 3: YANG Data Module of I2NSF Capability 2511 7. IANA Considerations 2513 This document requests IANA to register the following URI in the 2514 "IETF XML Registry" [RFC3688]: 2516 ID: yang:ietf-i2nsf-capability 2517 URI: urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability 2518 Registrant Contact: The IESG. 2519 XML: N/A; the requested URI is an XML namespace. 2520 Filename: [ TBD-at-Registration ] 2521 Reference: [ RFC-to-be ] 2523 This document requests IANA to register the following YANG module in 2524 the "YANG Module Names" registry [RFC7950][RFC8525]: 2526 Name: ietf-i2nsf-capability 2527 Maintained by IANA? N 2528 Namespace: urn:ietf:params:xml:ns:yang:ietf-i2nsf-capability 2529 Prefix: i2nsfcap 2530 Module: 2531 Reference: [ RFC-to-be ] 2533 8. Privacy Considerations 2535 This YANG module specifies the capabilities of NSFs. These 2536 capabilities are consistent with the diverse set of network security 2537 functions in common use in enterprise security operations. The 2538 configuration of the capabilities may entail privacy-sensitive 2539 information as explicitly outlined in Section 9. The NSFs 2540 implementing these capabilities may inspect, alter or drop user 2541 traffic; and be capable of attributing user traffic to individual 2542 users. 2544 Due to the sensitivity of these capabilities, notice must be provided 2545 to and consent must be received from the users of the network. 2546 Additionally, the collected data and associated infrastructure must 2547 be secured to prevent the leakage or unauthorized disclosure of this 2548 private data. 2550 9. Security Considerations 2552 The YANG module specified in this document defines a data schema 2553 designed to be accessed through network management protocols such as 2554 NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest layer of NETCONF 2555 protocol layers MUST use Secure Shell (SSH) [RFC4254][RFC6242] as a 2556 secure transport layer. The lowest layer of RESTCONF protocol layers 2557 MUST use HTTP over Transport Layer Security (TLS) [RFC8446], that is, 2558 HTTPS as a secure transport layer. 2560 The Network Configuration Access Control Model (NACM) [RFC8341] 2561 provides a means of restricting access to specific NETCONF or 2562 RESTCONF users to a preconfigured subset of all available NETCONF or 2563 RESTCONF protocol operations and contents. Thus, NACM SHOULD be used 2564 to restrict the NSF registration from unauthorized users. 2566 There are a number of data nodes defined in this YANG module that are 2567 writable, creatable, and deletable (i.e., config true, which is the 2568 default). These data nodes may be considered sensitive or vulnerable 2569 in some network environments. Write operations to these data nodes 2570 could have a negative effect on network and security operations. 2571 These data nodes are collected into a single list node. This list 2572 node is defined by list nsf with the following sensitivity/ 2573 vulnerability: 2575 * list nsf: An attacker could alter the security capabilities 2576 associated with an NSF in the database maintained by the security 2577 controller. Such changes could result in security functionality 2578 going unused due to the controller not having a record of it, and 2579 could also result in falsely claiming security capabilities that 2580 the controller would then attempt to use but would not actually be 2581 provided. 2583 Some of the readable data nodes in this YANG module may be considered 2584 sensitive or vulnerable in some network environments. It is thus 2585 important to control read access (e.g., via get, get-config, or 2586 notification) to these data nodes. These are the subtrees and data 2587 nodes with their sensitivity/vulnerability: 2589 * list nsf: The leak of this node to an attacker could reveal the 2590 specific configuration of security controls to an attacker. An 2591 attacker can craft an attack path that avoids observation or 2592 mitigations by getting the information of available security 2593 capabilities in a victim network. 2595 Some of the capability indicators (i.e., identities) defined in this 2596 document are highly sensitive and/or privileged operations that 2597 inherently require access to individuals' private data. These are 2598 subtrees and data nodes that are considered privacy-sensitive: 2600 * url-filtering-capability: URLs themselves often contain sensitive 2601 information [CAPABILITY-URLS], and access to URLs typically comes 2602 hand-in-hand with access to request and response content, which is 2603 also often sensitive. 2605 * voip-vocn-filtering-capability: The NSF that is able to filter 2606 VoIP/VoCN calls might identify certain individual identification. 2608 * user-condition-capabilities: The capability uses a set of IP 2609 addresses mapped to users. 2611 * geographic-capabilities: The IP address used in this capability 2612 can identify a user's geographical location. 2614 It is noted that some private information is made accessible in this 2615 manner. Thus, the nodes/entities given access to this data MUST be 2616 tightly secured, monitored, and audited to prevent leakage or other 2617 unauthorized disclosure of private data. Refer to [RFC6973] for the 2618 description of privacy aspects that protocol designers (including 2619 YANG data model designers) should consider along with regular 2620 security and privacy analysis. 2622 10. References 2624 10.1. Normative References 2626 [RFC0768] Postel, J., "User Datagram Protocol", STD 6, RFC 768, 2627 DOI 10.17487/RFC0768, August 1980, 2628 . 2630 [RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791, 2631 DOI 10.17487/RFC0791, September 1981, 2632 . 2634 [RFC0792] Postel, J., "Internet Control Message Protocol", STD 5, 2635 RFC 792, DOI 10.17487/RFC0792, September 1981, 2636 . 2638 [RFC0854] Postel, J. and J. Reynolds, "Telnet Protocol 2639 Specification", STD 8, RFC 854, DOI 10.17487/RFC0854, May 2640 1983, . 2642 [RFC0959] Postel, J. and J. Reynolds, "File Transfer Protocol", 2643 STD 9, RFC 959, DOI 10.17487/RFC0959, October 1985, 2644 . 2646 [RFC1939] Myers, J. and M. Rose, "Post Office Protocol - Version 3", 2647 STD 53, RFC 1939, DOI 10.17487/RFC1939, May 1996, 2648 . 2650 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 2651 Requirement Levels", BCP 14, RFC 2119, 2652 DOI 10.17487/RFC2119, March 1997, 2653 . 2655 [RFC2474] Nichols, K., Blake, S., Baker, F., and D. Black, 2656 "Definition of the Differentiated Services Field (DS 2657 Field) in the IPv4 and IPv6 Headers", RFC 2474, 2658 DOI 10.17487/RFC2474, December 1998, 2659 . 2661 [RFC2595] Newman, C., "Using TLS with IMAP, POP3 and ACAP", 2662 RFC 2595, DOI 10.17487/RFC2595, June 1999, 2663 . 2665 [RFC3022] Srisuresh, P. and K. Egevang, "Traditional IP Network 2666 Address Translator (Traditional NAT)", RFC 3022, 2667 DOI 10.17487/RFC3022, January 2001, 2668 . 2670 [RFC3168] Ramakrishnan, K., Floyd, S., and D. Black, "The Addition 2671 of Explicit Congestion Notification (ECN) to IP", 2672 RFC 3168, DOI 10.17487/RFC3168, September 2001, 2673 . 2675 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, 2676 A., Peterson, J., Sparks, R., Handley, M., and E. 2677 Schooler, "SIP: Session Initiation Protocol", RFC 3261, 2678 DOI 10.17487/RFC3261, June 2002, 2679 . 2681 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 2682 DOI 10.17487/RFC3688, January 2004, 2683 . 2685 [RFC4250] Lehtinen, S. and C. Lonvick, Ed., "The Secure Shell (SSH) 2686 Protocol Assigned Numbers", RFC 4250, 2687 DOI 10.17487/RFC4250, January 2006, 2688 . 2690 [RFC4254] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH) 2691 Connection Protocol", RFC 4254, DOI 10.17487/RFC4254, 2692 January 2006, . 2694 [RFC4340] Kohler, E., Handley, M., and S. Floyd, "Datagram 2695 Congestion Control Protocol (DCCP)", RFC 4340, 2696 DOI 10.17487/RFC4340, March 2006, 2697 . 2699 [RFC4443] Conta, A., Deering, S., and M. Gupta, Ed., "Internet 2700 Control Message Protocol (ICMPv6) for the Internet 2701 Protocol Version 6 (IPv6) Specification", STD 89, 2702 RFC 4443, DOI 10.17487/RFC4443, March 2006, 2703 . 2705 [RFC4766] Wood, M. and M. Erlinger, "Intrusion Detection Message 2706 Exchange Requirements", RFC 4766, DOI 10.17487/RFC4766, 2707 March 2007, . 2709 [RFC5103] Trammell, B. and E. Boschi, "Bidirectional Flow Export 2710 Using IP Flow Information Export (IPFIX)", RFC 5103, 2711 DOI 10.17487/RFC5103, January 2008, 2712 . 2714 [RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321, 2715 DOI 10.17487/RFC5321, October 2008, 2716 . 2718 [RFC5595] Fairhurst, G., "The Datagram Congestion Control Protocol 2719 (DCCP) Service Codes", RFC 5595, DOI 10.17487/RFC5595, 2720 September 2009, . 2722 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 2723 the Network Configuration Protocol (NETCONF)", RFC 6020, 2724 DOI 10.17487/RFC6020, October 2010, 2725 . 2727 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 2728 and A. Bierman, Ed., "Network Configuration Protocol 2729 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 2730 . 2732 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 2733 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 2734 . 2736 [RFC6335] Cotton, M., Eggert, L., Touch, J., Westerlund, M., and S. 2737 Cheshire, "Internet Assigned Numbers Authority (IANA) 2738 Procedures for the Management of the Service Name and 2739 Transport Protocol Port Number Registry", BCP 165, 2740 RFC 6335, DOI 10.17487/RFC6335, August 2011, 2741 . 2743 [RFC6437] Amante, S., Carpenter, B., Jiang, S., and J. Rajahalme, 2744 "IPv6 Flow Label Specification", RFC 6437, 2745 DOI 10.17487/RFC6437, November 2011, 2746 . 2748 [RFC6691] Borman, D., "TCP Options and Maximum Segment Size (MSS)", 2749 RFC 6691, DOI 10.17487/RFC6691, July 2012, 2750 . 2752 [RFC6864] Touch, J., "Updated Specification of the IPv4 ID Field", 2753 RFC 6864, DOI 10.17487/RFC6864, February 2013, 2754 . 2756 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 2757 RFC 6991, DOI 10.17487/RFC6991, July 2013, 2758 . 2760 [RFC7323] Borman, D., Braden, B., Jacobson, V., and R. 2761 Scheffenegger, Ed., "TCP Extensions for High Performance", 2762 RFC 7323, DOI 10.17487/RFC7323, September 2014, 2763 . 2765 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 2766 RFC 7950, DOI 10.17487/RFC7950, August 2016, 2767 . 2769 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 2770 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 2771 . 2773 [RFC8075] Castellani, A., Loreto, S., Rahman, A., Fossati, T., and 2774 E. Dijk, "Guidelines for Mapping Implementations: HTTP to 2775 the Constrained Application Protocol (CoAP)", RFC 8075, 2776 DOI 10.17487/RFC8075, February 2017, 2777 . 2779 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2780 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2781 May 2017, . 2783 [RFC8200] Deering, S. and R. Hinden, "Internet Protocol, Version 6 2784 (IPv6) Specification", STD 86, RFC 8200, 2785 DOI 10.17487/RFC8200, July 2017, 2786 . 2788 [RFC8311] Black, D., "Relaxing Restrictions on Explicit Congestion 2789 Notification (ECN) Experimentation", RFC 8311, 2790 DOI 10.17487/RFC8311, January 2018, 2791 . 2793 [RFC8329] Lopez, D., Lopez, E., Dunbar, L., Strassner, J., and R. 2794 Kumar, "Framework for Interface to Network Security 2795 Functions", RFC 8329, DOI 10.17487/RFC8329, February 2018, 2796 . 2798 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 2799 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 2800 . 2802 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 2803 Access Control Model", STD 91, RFC 8341, 2804 DOI 10.17487/RFC8341, March 2018, 2805 . 2807 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 2808 and R. Wilton, "Network Management Datastore Architecture 2809 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 2810 . 2812 [RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of 2813 Documents Containing YANG Data Models", BCP 216, RFC 8407, 2814 DOI 10.17487/RFC8407, October 2018, 2815 . 2817 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol 2818 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, 2819 . 2821 [RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K., 2822 and R. Wilton, "YANG Library", RFC 8525, 2823 DOI 10.17487/RFC8525, March 2019, 2824 . 2826 [RFC8805] Kline, E., Duleba, K., Szamonek, Z., Moser, S., and W. 2827 Kumari, "A Format for Self-Published IP Geolocation 2828 Feeds", RFC 8805, DOI 10.17487/RFC8805, August 2020, 2829 . 2831 [RFC9051] Melnikov, A., Ed. and B. Leiba, Ed., "Internet Message 2832 Access Protocol (IMAP) - Version 4rev2", RFC 9051, 2833 DOI 10.17487/RFC9051, August 2021, 2834 . 2836 [I-D.ietf-httpbis-http2bis] 2837 Thomson, M. and C. Benfield, "HTTP/2", Work in Progress, 2838 Internet-Draft, draft-ietf-httpbis-http2bis-07, 24 January 2839 2022, . 2842 [I-D.ietf-httpbis-messaging] 2843 Fielding, R. T., Nottingham, M., and J. Reschke, 2844 "HTTP/1.1", Work in Progress, Internet-Draft, draft-ietf- 2845 httpbis-messaging-19, 12 September 2021, 2846 . 2849 [I-D.ietf-httpbis-semantics] 2850 Fielding, R. T., Nottingham, M., and J. Reschke, "HTTP 2851 Semantics", Work in Progress, Internet-Draft, draft-ietf- 2852 httpbis-semantics-19, 12 September 2021, 2853 . 2856 [I-D.ietf-i2nsf-nsf-facing-interface-dm] 2857 Kim, J. T., Jeong, J. P., Park, J., Hares, S., and Q. Lin, 2858 "I2NSF Network Security Function-Facing Interface YANG 2859 Data Model", Work in Progress, Internet-Draft, draft-ietf- 2860 i2nsf-nsf-facing-interface-dm-27, 14 May 2022, 2861 . 2864 [I-D.ietf-i2nsf-nsf-monitoring-data-model] 2865 Jeong, J. (., Lingga, P., Hares, S., Xia, L. (., and H. 2866 Birkholz, "I2NSF NSF Monitoring Interface YANG Data 2867 Model", Work in Progress, Internet-Draft, draft-ietf- 2868 i2nsf-nsf-monitoring-data-model-18, 19 April 2022, 2869 . 2872 [I-D.ietf-i2nsf-registration-interface-dm] 2873 Hyun, S., Jeong, J. (., Roh, T., Wi, S., and J. Park, 2874 "I2NSF Registration Interface YANG Data Model", Work in 2875 Progress, Internet-Draft, draft-ietf-i2nsf-registration- 2876 interface-dm-16, 13 April 2022, 2877 . 2880 [I-D.ietf-tcpm-rfc793bis] 2881 Eddy, W. M., "Transmission Control Protocol (TCP) 2882 Specification", Work in Progress, Internet-Draft, draft- 2883 ietf-tcpm-rfc793bis-28, 7 March 2022, 2884 . 2887 [I-D.ietf-tcpm-accurate-ecn] 2888 Briscoe, B., Kühlewind, M., and R. Scheffenegger, "More 2889 Accurate ECN Feedback in TCP", Work in Progress, Internet- 2890 Draft, draft-ietf-tcpm-accurate-ecn-18, 22 March 2022, 2891 . 2894 [I-D.ietf-tsvwg-rfc4960-bis] 2895 Stewart, R. R., Tüxen, M., and K. E. E. Nielsen, "Stream 2896 Control Transmission Protocol", Work in Progress, 2897 Internet-Draft, draft-ietf-tsvwg-rfc4960-bis-19, 5 2898 February 2022, . 2901 [I-D.ietf-tsvwg-udp-options] 2902 Touch, J., "Transport Options for UDP", Work in Progress, 2903 Internet-Draft, draft-ietf-tsvwg-udp-options-18, 26 March 2904 2022, . 2907 10.2. Informative References 2909 [RFC6973] Cooper, A., Tschofenig, H., Aboba, B., Peterson, J., 2910 Morris, J., Hansen, M., and R. Smith, "Privacy 2911 Considerations for Internet Protocols", RFC 6973, 2912 DOI 10.17487/RFC6973, July 2013, 2913 . 2915 [RFC8192] Hares, S., Lopez, D., Zarny, M., Jacquenet, C., Kumar, R., 2916 and J. Jeong, "Interface to Network Security Functions 2917 (I2NSF): Problem Statement and Use Cases", RFC 8192, 2918 DOI 10.17487/RFC8192, July 2017, 2919 . 2921 [RFC9000] Iyengar, J., Ed. and M. Thomson, Ed., "QUIC: A UDP-Based 2922 Multiplexed and Secure Transport", RFC 9000, 2923 DOI 10.17487/RFC9000, May 2021, 2924 . 2926 [IANA-Protocol-Numbers] 2927 "Assigned Internet Protocol Numbers", Available: 2928 https://www.iana.org/assignments/protocol- 2929 numbers/protocol-numbers.xhtml, September 2020. 2931 [IEEE802.3-2018] 2932 Committee, I. S., "IEEE 802.3-2018 - IEEE Standard for 2933 Ethernet", August 2018, 2934 . 2936 [Alshaer] Shaer, Al., Hamed, E., and H. Hamed, "Modeling and 2937 management of firewall policies", 2004. 2939 [Hirschman] 2940 Hirschman, L. and R. Gaizauskas, "Natural Language 2941 Question Answering: The View from Here", Natural Language 2942 Engineering 7:4, pgs 275-300, Cambridge University Press , 2943 November 2001. 2945 [Hohpe] Hohpe, G. and B. Woolf, "Enterprise Integration Patterns", 2946 ISBN 0-32-120068-3 , 2003. 2948 [Martin] Martin, R.C., "Agile Software Development, Principles, 2949 Patterns, and Practices", Prentice-Hall , ISBN: 2950 0-13-597444-5 , 2002. 2952 [OODMP] "https://www.oodesign.com/mediator-pattern.html". 2954 [OODOP] "https://www.oodesign.com/observer-pattern.html". 2956 [OODSRP] "https://www.oodesign.com/single-responsibility- 2957 principle.html". 2959 [CAPABILITY-URLS] 2960 Tennison, J., "Good Practices for Capability URLs", 2961 October 2014, 2962 . 2964 Appendix A. Configuration Examples 2966 This section shows configuration examples of "ietf-i2nsf-capability" 2967 module for capabilities registration of general firewall. 2969 A.1. Example 1: Registration for the Capabilities of a General Firewall 2971 This section shows a configuration example for the capabilities 2972 registration of a general firewall in either an IPv4 network or an 2973 IPv6 network. 2975 2976 general_firewall 2977 2978 2979 next-header 2980 flow-direction 2981 source-address 2982 destination-address 2983 source-port-number 2984 destination-port-number 2985 source-port-number 2986 destination-port-number 2987 2988 2989 2990 pass 2991 drop 2992 mirror 2993 pass 2994 drop 2995 mirror 2996 2997 2999 Figure 4: Configuration XML for the Capabilities Registration of 3000 a General Firewall in an IPv4 Network 3002 Figure 4 shows the configuration XML for the capabilities 3003 registration of a general firewall as an NSF in an IPv4 network. Its 3004 capabilities are as follows. 3006 1. The name of the NSF is general_firewall. 3008 2. The NSF can inspect the IPv4 protocol header field, flow 3009 direction, source address(es), and destination address(es) 3011 3. The NSF can inspect the port number(s) and flow direction for the 3012 transport layer protocol, i.e., TCP and UDP. 3014 4. The NSF can control whether the packets are allowed to pass, 3015 drop, or mirror. 3017 3018 general_firewall 3019 3020 3021 next-header 3022 flow-direction 3023 source-address 3024 destination-address 3025 source-port-number 3026 destination-port-number 3027 source-port-number 3028 destination-port-number 3029 3030 3031 3032 pass 3033 drop 3034 mirror 3035 pass 3036 drop 3037 mirror 3038 3039 3041 Figure 5: Configuration XML for the Capabilities Registration of 3042 a General Firewall in an IPv6 Network 3044 In addition, Figure 5 shows the configuration XML for the 3045 capabilities registration of a general firewall as an NSF in an IPv6 3046 network. Its capabilities are as follows. 3048 1. The name of the NSF is general_firewall. 3050 2. The NSF can inspect IPv6 next header, flow direction, source 3051 address(es), and destination address(es) 3053 3. The NSF can inspect the port number(s) and flow direction for the 3054 transport layer protocol, i.e., TCP and UDP. 3056 4. The NSF can control whether the packets are allowed to pass, 3057 drop, or mirror. 3059 A.2. Example 2: Registration for the Capabilities of a Time-based 3060 Firewall 3062 This section shows a configuration example for the capabilities 3063 registration of a time-based firewall in either an IPv4 network or an 3064 IPv6 network. 3066 3067 time_based_firewall 3068 3069 3070 next-header 3071 flow-direction 3072 source-address 3073 destination-address 3074 3075 absolute-time 3076 periodic-time 3077 3078 3079 3080 3081 pass 3082 drop 3083 mirror 3084 pass 3085 drop 3086 mirror 3087 3088 3090 Figure 6: Configuration XML for the Capabilities Registration of 3091 a Time-based Firewall in an IPv4 Network 3093 Figure 6 shows the configuration XML for the capabilities 3094 registration of a time-based firewall as an NSF in an IPv4 network. 3095 Its capabilities are as follows. 3097 1. The name of the NSF is time_based_firewall. 3099 2. The NSF can execute the security policy rule according to 3100 absolute time and periodic time. 3102 3. The NSF can inspect the IPv4 protocol header field, flow 3103 direction, source address(es), and destination address(es). 3105 4. The NSF can control whether the packets are allowed to pass, 3106 drop, or mirror. 3108 3109 time_based_firewall 3110 3111 3112 next-header 3113 flow-direction 3114 source-address 3115 destination-address 3116 3117 absolute-time 3118 periodic-time 3119 3120 3121 3122 3123 pass 3124 drop 3125 mirror 3126 pass 3127 drop 3128 mirror 3129 3130 3132 Figure 7: Configuration XML for the Capabilities Registration of 3133 a Time-based Firewall in an IPv6 Network 3135 In addition, Figure 7 shows the configuration XML for the 3136 capabilities registration of a time-based firewall as an NSF in an 3137 IPv6 network. Its capabilities are as follows. 3139 1. The name of the NSF is time_based_firewall. 3141 2. The NSF can execute the security policy rule according to 3142 absolute time and periodic time. 3144 3. The NSF can inspect the IPv6 protocol header field, flow 3145 direction, source address(es), and destination address(es). 3147 4. The NSF can control whether the packets are allowed to pass, 3148 drop, or mirror. 3150 A.3. Example 3: Registration for the Capabilities of a Web Filter 3152 This section shows a configuration example for the capabilities 3153 registration of a web filter. 3155 3156 web_filter 3157 3158 3159 user-defined 3160 3161 3162 3163 pass 3164 drop 3165 mirror 3166 pass 3167 drop 3168 mirror 3169 3170 3172 Figure 8: Configuration XML for the Capabilities Registration of 3173 a Web Filter 3175 Figure 8 shows the configuration XML for the capabilities 3176 registration of a web filter as an NSF. Its capabilities are as 3177 follows. 3179 1. The name of the NSF is web_filter. 3181 2. The NSF can inspect a URL matched from a user-defined URL. User 3182 can specify their own URL. 3184 3. The NSF can control whether the packets are allowed to pass, 3185 drop, or mirror. 3187 4. Overall, the NSF can compare the URL of a packet to a user- 3188 defined database. The matched packet can be passed, dropped, or 3189 mirrored. 3191 A.4. Example 4: Registration for the Capabilities of a VoIP/VoCN Filter 3193 This section shows a configuration example for the capabilities 3194 registration of a VoIP/VoCN filter. 3196 3197 voip_vocn_filter 3198 3199 3200 3201 call-id 3202 3203 3204 3205 3206 pass 3207 drop 3208 mirror 3209 pass 3210 drop 3211 mirror 3212 3213 3215 Figure 9: Configuration XML for the Capabilities Registration of 3216 a VoIP/VoCN Filter 3218 Figure 9 shows the configuration XML for the capabilities 3219 registration of a VoIP/VoCN filter as an NSF. Its capabilities are 3220 as follows. 3222 1. The name of the NSF is voip_vocn_filter. 3224 2. The NSF can inspect a voice call id for VoIP/VoCN packets. 3226 3. The NSF can control whether the packets are allowed to pass, 3227 drop, or mirror. 3229 A.5. Example 5: Registration for the Capabilities of an HTTP and HTTPS 3230 Flood Mitigator 3232 This section shows a configuration example for the capabilities 3233 registration of a HTTP and HTTPS flood mitigator. 3235 3236 DDoS_mitigator 3237 3238 3239 packet-rate 3240 byte-rate 3241 flow-rate 3242 3243 3244 3245 pass 3246 drop 3247 mirror 3248 pass 3249 drop 3250 mirror 3251 3252 3254 Figure 10: Configuration XML for the Capabilities Registration of 3255 a HTTP and HTTPS Flood Mitigator 3257 Figure 10 shows the configuration XML for the capabilities 3258 registration of a HTTP and HTTPS flood mitigator as an NSF. Its 3259 capabilities are as follows. 3261 1. The name of the NSF is DDoS_mitigator. 3263 2. The NSF can detect the amount of packet, flow, and byte rate in 3264 the network for potential DDoS Attack. 3266 3. The NSF can control whether the packets are allowed to pass, 3267 drop, or mirror. 3269 Appendix B. Acknowledgments 3271 This document is a product by the I2NSF Working Group (WG) including 3272 WG Chairs (i.e., Linda Dunbar and Yoav Nir) and Diego Lopez. This 3273 document took advantage of the review and comments from the following 3274 experts: Roman Danyliw, Acee Lindem, Paul Wouters (SecDir), Michael 3275 Scharf (TSVART), Dan Romascanu (GenART), and Tom Petch. The authors 3276 sincerely appreciate their sincere efforts and kind help. 3278 This work was supported by Institute of Information & Communications 3279 Technology Planning & Evaluation (IITP) grant funded by the Korea 3280 MSIT (Ministry of Science and ICT) (R-20160222-002755, Cloud based 3281 Security Intelligence Technology Development for the Customized 3282 Security Service Provisioning). This work was supported in part by 3283 the IITP grant funded by the MSIT (2020-0-00395, Standard Development 3284 of Blockchain based Network Management Automation Technology). 3286 Appendix C. Contributors 3288 The following are co-authors of this document: 3290 Patrick Lingga - Department of Electrical and Computer Engineering, 3291 Sungkyunkwan University, 2066 Seobu-ro Jangan-gu, Suwon, Gyeonggi-do 3292 16419, Republic of Korea, EMail: patricklink@skku.edu 3294 Liang Xia - Huawei, 101 Software Avenue, Nanjing, Jiangsu 210012, 3295 China, EMail: Frank.Xialiang@huawei.com 3297 Cataldo Basile - Politecnico di Torino, Corso Duca degli Abruzzi, 34, 3298 Torino, 10129, Italy, EMail: cataldo.basile@polito.it 3300 John Strassner - Huawei, 2330 Central Expressway, Santa Clara, CA 3301 95050, USA, EMail: John.sc.Strassner@huawei.com 3303 Diego R. Lopez - Telefonica I+D, Zurbaran, 12, Madrid, 28010, Spain, 3304 Email: diego.r.lopez@telefonica.com 3306 Hyoungshick Kim - Department of Computer Science and Engineering, 3307 Sungkyunkwan University, 2066 Seobu-ro Jangan-gu, Suwon, Gyeonggi-do 3308 16419, Republic of Korea, EMail: hyoung@skku.edu 3310 Daeyoung Hyun - Department of Computer Science and Engineering, 3311 Sungkyunkwan University, 2066 Seobu-ro Jangan-gu, Suwon, Gyeonggi-do 3312 16419, Republic of Korea, EMail: dyhyun@skku.edu 3314 Dongjin Hong - Department of Electronic, Electrical and Computer 3315 Engineering, Sungkyunkwan University, 2066 Seobu-ro Jangan-gu, Suwon, 3316 Gyeonggi-do 16419, Republic of Korea, EMail: dong.jin@skku.edu 3318 Jung-Soo Park - Electronics and Telecommunications Research 3319 Institute, 218 Gajeong-Ro, Yuseong-Gu, Daejeon, 34129, Republic of 3320 Korea, EMail: pjs@etri.re.kr 3322 Tae-Jin Ahn - Korea Telecom, 70 Yuseong-Ro, Yuseong-Gu, Daejeon, 3323 305-811, Republic of Korea, EMail: taejin.ahn@kt.com 3324 Se-Hui Lee - Korea Telecom, 70 Yuseong-Ro, Yuseong-Gu, Daejeon, 3325 305-811, Republic of Korea, EMail: sehuilee@kt.com 3327 Appendix D. Changes from draft-ietf-i2nsf-capability-data-model-31 3329 The following changes are made from draft-ietf-i2nsf-capability-data- 3330 model-31: 3332 * The YANG module's prefix is updated from 'nsfcap' to 'i2nsfcap'. 3334 Authors' Addresses 3336 Susan Hares (editor) 3337 Huawei 3338 7453 Hickory Hill 3339 Saline, MI 48176 3340 United States of America 3341 Phone: +1-734-604-0332 3342 Email: shares@ndzh.com 3344 Jaehoon Paul Jeong (editor) 3345 Department of Computer Science and Engineering 3346 Sungkyunkwan University 3347 2066 Seobu-Ro, Jangan-Gu 3348 Suwon 3349 Gyeonggi-Do 3350 16419 3351 Republic of Korea 3352 Phone: +82 31 299 4957 3353 Email: pauljeong@skku.edu 3354 URI: http://iotlab.skku.edu/people-jaehoon-jeong.php 3356 Jinyong Tim Kim 3357 Department of Electronic, Electrical and Computer Engineering 3358 Sungkyunkwan University 3359 2066 Seobu-Ro, Jangan-Gu 3360 Suwon 3361 Gyeonggi-Do 3362 16419 3363 Republic of Korea 3364 Phone: +82 10 8273 0930 3365 Email: timkim@skku.edu 3366 Robert Moskowitz 3367 HTT Consulting 3368 Oak Park, MI 3369 United States of America 3370 Phone: +1-248-968-9809 3371 Email: rgm@htt-consult.com 3373 Qiushi Lin 3374 Huawei 3375 Huawei Industrial Base 3376 Shenzhen 3377 Guangdong 518129, 3378 China 3379 Email: linqiushi@huawei.com