--- 1/draft-ietf-i2nsf-consumer-facing-interface-dm-14.txt 2021-09-15 09:14:04.263321794 -0700 +++ 2/draft-ietf-i2nsf-consumer-facing-interface-dm-15.txt 2021-09-15 09:14:04.371324511 -0700 @@ -1,24 +1,24 @@ I2NSF Working Group J. Jeong, Ed. Internet-Draft C. Chung Intended status: Standards Track Sungkyunkwan University -Expires: 22 February 2022 T. Ahn +Expires: 19 March 2022 T. Ahn Korea Telecom R. Kumar Juniper Networks S. Hares Huawei - 21 August 2021 + 15 September 2021 I2NSF Consumer-Facing Interface YANG Data Model - draft-ietf-i2nsf-consumer-facing-interface-dm-14 + draft-ietf-i2nsf-consumer-facing-interface-dm-15 Abstract This document describes an information model and a YANG data model for the Consumer-Facing Interface between an Interface to Network Security Functions (I2NSF) User and Security Controller in an I2NSF system in a Network Functions Virtualization (NFV) environment. The information model defines various types of managed objects and the relationship among them needed to build the interface. The information model is based on the "Event-Condition-Action" (ECA) @@ -35,21 +35,21 @@ Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." - This Internet-Draft will expire on 22 February 2022. + This Internet-Draft will expire on 19 March 2022. Copyright Notice Copyright (c) 2021 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/ license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights @@ -62,50 +62,50 @@ 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 5 3. Information Model for Policy . . . . . . . . . . . . . . . . 5 3.1. Event Sub-model . . . . . . . . . . . . . . . . . . . . . 7 3.2. Condition Sub-model . . . . . . . . . . . . . . . . . . . 8 3.3. Action Sub-model . . . . . . . . . . . . . . . . . . . . 10 4. Information Model for Policy Endpoint Groups . . . . . . . . 11 4.1. User Group . . . . . . . . . . . . . . . . . . . . . . . 12 4.2. Device Group . . . . . . . . . . . . . . . . . . . . . . 13 - 4.3. Location Group . . . . . . . . . . . . . . . . . . . . . 14 + 4.3. Location Group . . . . . . . . . . . . . . . . . . . . . 13 4.4. URL Group . . . . . . . . . . . . . . . . . . . . . . . . 14 5. Information Model for Threat Prevention . . . . . . . . . . . 15 5.1. Threat Feed . . . . . . . . . . . . . . . . . . . . . . . 15 5.2. Payload Content . . . . . . . . . . . . . . . . . . . . . 16 6. Network Configuration Access Control Model (NACM) for I2NSF Consumer-Facing Interface . . . . . . . . . . . . . . . . 17 7. YANG Data Model of Consumer-Facing Interface . . . . . . . . 19 7.1. YANG Module of Consumer-Facing Interface . . . . . . . . 19 8. XML Configuration Examples of High-Level Security Policy - Rules . . . . . . . . . . . . . . . . . . . . . . . . . . 46 + Rules . . . . . . . . . . . . . . . . . . . . . . . . . . 47 8.1. Database Registration: Information of Positions and Devices - (Endpoint Group) . . . . . . . . . . . . . . . . . . . . 46 - 8.2. Scenario 1: Block SNS Access during Business Hours . . . 48 + (Endpoint Group) . . . . . . . . . . . . . . . . . . . . 47 + 8.2. Scenario 1: Block SNS Access during Business Hours . . . 49 8.3. Scenario 2: Block Malicious VoIP/VoLTE Packets Coming to a - Company . . . . . . . . . . . . . . . . . . . . . . . . . 50 + Company . . . . . . . . . . . . . . . . . . . . . . . . . 51 8.4. Scenario 3: Mitigate HTTP and HTTPS Flood Attacks on a - Company Web Server . . . . . . . . . . . . . . . . . . . 51 + Company Web Server . . . . . . . . . . . . . . . . . . . 52 9. XML Configuration Example of a User Group's Access Control for - I2NSF Consumer-Facing Interface . . . . . . . . . . . . . 52 - 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 54 - 11. Security Considerations . . . . . . . . . . . . . . . . . . . 54 - 12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 55 - 13. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 55 - 14. References . . . . . . . . . . . . . . . . . . . . . . . . . 56 - 14.1. Normative References . . . . . . . . . . . . . . . . . . 56 - 14.2. Informative References . . . . . . . . . . . . . . . . . 57 + I2NSF Consumer-Facing Interface . . . . . . . . . . . . . 53 + 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 55 + 11. Security Considerations . . . . . . . . . . . . . . . . . . . 55 + 12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 56 + 13. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 57 + 14. References . . . . . . . . . . . . . . . . . . . . . . . . . 57 + 14.1. Normative References . . . . . . . . . . . . . . . . . . 57 + 14.2. Informative References . . . . . . . . . . . . . . . . . 60 Appendix A. Changes from - draft-ietf-i2nsf-consumer-facing-interface-dm-13 . . . . 59 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 59 + draft-ietf-i2nsf-consumer-facing-interface-dm-14 . . . . 62 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 62 1. Introduction In a framework of Interface to Network Security Functions (I2NSF) [RFC8329], each vendor can register their NSFs using a Developer's Management System (DMS). Assuming that vendors also provide the front-end web applications registered with an I2NSF User, the Consumer-Facing Interface is required because the web applications developed by each vendor need to have a standard interface specifying the data types used when the I2NSF User and Security Controller @@ -268,22 +268,26 @@ Action: This field identifies the action taken when a rule is matched. There is always an implicit action to drop traffic if no rule is matched for a traffic type. See details in Section 4.3. +--rw rules* [rule-name] | +--rw rule-name string | +--rw priority? uint8 | +--rw event + | ... | +--rw condition + | ... | +--rw actions + ... + Figure 3: Rule YANG Data Tree Note that in the case of policy conflicts, the resolution of the conflicted policies conforms to the guidelines of "Information Model of NSFs Capabilities" [I-D.ietf-i2nsf-capability]. 3.1. Event Sub-model The Event Object contains information related to scheduling a Rule. The Rule could be activated based on a set time or security event. @@ -307,31 +311,31 @@ Period: This represents the period of time the rule event is active. It can be configured by the start-time, stop-time, day, date, and month. Frequency: This represents how frequent the rule should be enforced. There are four options: "only-once", "daily", "weekly", "monthly" or "yearly". +--rw event - +--rw security-event identityref - +--rw time-information + | +--rw security-event? identityref + | +--rw time | +--rw start-date-time? yang:date-and-time | +--rw end-date-time? yang:date-and-time | +--rw period | | +--rw start-time? time - | | +--rw stop-time? time + | | +--rw end-time? time | | +--rw day* identityref | | +--rw date* int32 | | +--rw month* string - +--rw frequency? enumeration + | +--rw frequency? enumeration Figure 4: Event Sub-model YANG Data Tree 3.2. Condition Sub-model This object represents Conditions that Security Administrator wants to apply the checking on the traffic in order to determine whether the set of actions in the Rule can be executed or not. The Condition Sub-model consists of three different types of containers each representing different cases, such as general firewall and DDoS- @@ -508,26 +512,26 @@ Range-ipv6-address: This represents the IPv6 address range of a user in the user group. +--rw user-group* [name] | +--rw name string | +--rw mac-address* yang:mac-address | +--rw (match-type) | | +--:(range-match-ipv4) | | | +--rw range-ipv4-address - | | | +--rw start-ipv4-address inet:ipv4-address - | | | +--rw end-ipv4-address inet:ipv4-address + | | | +--rw start-ipv4-address inet:ipv4-address-no-zone + | | | +--rw end-ipv4-address inet:ipv4-address-no-zone | | +--:(range-match-ipv6) | | +--rw range-ipv6-address - | | +--rw start-ipv6-address inet:ipv6-address - | | +--rw end-ipv6-address inet:ipv6-address + | | +--rw start-ipv6-address inet:ipv6-address-no-zone + | | +--rw end-ipv6-address inet:ipv6-address-no-zone Figure 9: User Group YANG Data Tree 4.2. Device Group This object represents a Device-Group. Figure 10 shows the YANG tree of the Device-group object. The Device-Group object SHALL have the following information: Name: This field identifies the name of this object. @@ -542,35 +546,31 @@ device in the device group. Range-ipv6-address: This represents the IPv6 address range of a device in the device group. Application-protocol: This represents the application layer protocols of devices. If this is not set, it cannot support the appropriate protocol +--rw device-group* [name] - +--rw name string - +--rw (match-type) - | +--:(exact-match-ipv4) - | | +--rw ipv4? inet:ipv4-address - | +--:(exact-match-ipv6) - | | +--rw ipv6? inet:ipv6-address - | +--:(range-match-ipv4) - | | +--rw range-ipv4-address* - | | | +--rw start-ipv4-address inet:ipv4-address - | | | +--rw end-ipv4-address inet:ipv4-address - | +--:(range-match-ipv6) - | | +--rw range-ipv6-address* - | | | +--rw start-ipv6-address inet:ipv6-address - | | | +--rw end-ipv6-address inet:ipv6-address - +--rw application-protocol* identityref + | +--rw name string + | +--rw (match-type) + | | +--:(range-match-ipv4) + | | | +--rw range-ipv4-address + | | | +--rw start-ipv4-address inet:ipv4-address-no-zone + | | | +--rw end-ipv4-address inet:ipv4-address-no-zone + | | +--:(range-match-ipv6) + | | +--rw range-ipv6-address + | | +--rw start-ipv6-address inet:ipv6-address-no-zone + | | +--rw end-ipv6-address inet:ipv6-address-no-zone + | +--rw application-protocol* identityref Figure 10: Device Group YANG Data Tree 4.3. Location Group This object represents a location group based on either tag or other information. Figure 11 shows the YANG tree of the Location-Group object. The Location-Group object SHALL have the following information: @@ -581,24 +581,24 @@ Geo-ip-ipv6: This field represents the IPv6 Geo-ip address of a location [RFC8805]. Continent: This field represents the continent where the location group member is located. +--rw location-group* [name] | +--rw name string | +--rw geo-ip-ipv4* [ipv4-address] - | | +--rw ipv4-address inet:ipv4-address + | | +--rw ipv4-address inet:ipv4-address-no-zone | | +--rw ipv4-prefix? inet:ipv4-prefix | +--rw geo-ip-ipv6* [ipv6-address] - | | +--rw ipv6-address inet:ipv6-address + | | +--rw ipv6-address inet:ipv6-address-no-zone | | +--rw ipv6-prefix? inet:ipv6-prefix | +--rw continent? identityref Figure 11: Location Group YANG Data Tree 4.4. URL Group This object represents a URL group based on a Uniform Resource Locator (URL) or web address. Figure 12 shows the YANG tree of the URL-Group object. The URLn-Group object SHALL have the following @@ -806,25 +807,27 @@ based firewall, VoIP/VoLTE security service, and DDoS-attack mitigation in Section 8. 7.1. YANG Module of Consumer-Facing Interface This section describes a YANG module of Consumer-Facing Interface. This document provides identities in the data model to be used for configuration of an NSF. Each identity is used for a different type of configuration. The details are explained in the description of each identity. This YANG module imports from [RFC6991]. It makes - references to - [RFC0854][RFC0959][RFC1939][RFC3022][RFC2818][RFC4250][RFC5321] - [RFC7230][RFC7231][STIX]. + references to [RFC0768][RFC0792][RFC0793] [RFC0854][RFC0959][RFC1939] + [RFC2818][RFC3022][RFC3261] [RFC3501][RFC4250][RFC4340] + [RFC4443][RFC5321][RFC7230] [RFC7231][I-D.ietf-i2nsf-capability] + [I-D.ietf-tcpm-rfc793bis][IANA-ICMP-Parameters] + [IANA-ICMPv6-Parameters][Encyclopedia-Britannica] [STIX]. - file "ietf-i2nsf-cfi-policy@2021-08-21.yang" + file "ietf-i2nsf-cfi-policy@2021-09-15.yang" module ietf-i2nsf-cfi-policy { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-i2nsf-cfi-policy"; prefix nsfcfi; import ietf-inet-types{ prefix inet; reference "RFC 6991"; } @@ -832,21 +834,21 @@ import ietf-yang-types{ prefix yang; reference "RFC 6991"; } organization "IETF I2NSF (Interface to Network Security Functions) Working Group"; contact - "WG Web: + "WG Web: WG List: Editor: Jaehoon Paul Jeong Editor: Patrick Lingga "; description "This module is a YANG module for Consumer-Facing Interface. @@ -861,29 +863,28 @@ Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices."; // RFC Ed.: replace XXXX with an actual RFC number and remove // this note. - revision "2021-08-21"{ + revision "2021-09-15" { description "Initial revision."; reference "RFC XXXX: I2NSF Consumer-Facing Interface YANG Data Model"; // RFC Ed.: replace XXXX with an actual RFC number and remove // this note. } - identity resolution-strategy { description "Base identity for resolution strategy"; reference "draft-ietf-i2nsf-capability-data-model-17: I2NSF Capability YANG Data Model - Resolution Strategy"; } identity fmr { base resolution-strategy; @@ -925,167 +926,174 @@ identity pmrn { base resolution-strategy; description "Identity for Prioritized Matching Rule with No Errors (PMRN)"; reference "draft-ietf-i2nsf-capability-data-model-17: I2NSF Capability YANG Data Model - Resolution Strategy"; } - identity security-event-type { + identity security-event { description "Base identity for security event types."; } - identity ddos { - base security-event-type; + identity anti-ddos { + base security-event; description - "Identity for DDoS event types."; + "Identity for Anti-DDoS event types."; } - identity intrusion { - base security-event-type; + identity ips { + base security-event; description - "Identity for intrusion event types."; + "Identity for Intrusion Prevention System event types."; } - identity web-attack { - base security-event-type; + identity url-filtering { + base security-event; description - "Identity for web-attack event types."; + "Identity for url-filtering event types."; } - identity voip-volte { - base security-event-type; + identity anti-virus { + base security-event; description - "Identity for VoIP/VoLTE event types."; + "Identity for Antivirus types."; + } + + identity voip-volte-filtering { + base security-event; + description + "Identity for VoIP/VoLTE Filtering event types."; } identity protocol { description "This identity represents the protocol types."; } - identity layer-4-protocol { + identity transport-protocol { base protocol; description "Base identity for the Layer 4 (i.e., Transport Layer) Protocols"; } identity tcp { - base layer-4-protocol; + base transport-protocol; description "Base identity for TCP condition capabilities"; reference "RFC 793: Transmission Control Protocol draft-ietf-tcpm-rfc793bis: Transmission Control Protocol (TCP) Specification"; } identity udp { - base layer-4-protocol; + base transport-protocol; description "Base identity for UDP condition capabilities"; reference "RFC 768: User Datagram Protocol"; } identity sctp { - base layer-4-protocol; + base transport-protocol; description "Identity for SCTP condition capabilities"; reference "RFC 4960: Stream Control Transmission Protocol"; } identity dccp { - base layer-4-protocol; + base transport-protocol; description "Identity for DCCP condition capabilities"; reference "RFC 4340: Datagram Congestion Control Protocol"; } - identity layer-7-protocol { + identity application-protocol { base protocol; description "Base identity for the Layer 7 (i.e., Application Layer) Protocols"; } identity ftp { - base layer-7-protocol; + base application-protocol; description "The identity for ftp protocol."; reference "RFC 959: File Transfer Protocol (FTP)"; } + identity ssh { - base layer-7-protocol; + base application-protocol; description "The identity for ssh protocol."; reference "RFC 4250: The Secure Shell (SSH) Protocol"; } identity telnet { - base layer-7-protocol; + base application-protocol; description "The identity for telnet."; reference "RFC 854: Telnet Protocol"; } identity smtp { - base layer-7-protocol; + base application-protocol; description "The identity for smtp."; reference "RFC 5321: Simple Mail Transfer Protocol (SMTP)"; } identity http { - base layer-7-protocol; + base application-protocol; description "The identity for http."; reference "RFC7230: Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing RFC7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content"; } identity https { - base layer-7-protocol; + base application-protocol; description "The identity for https."; reference "RFC 2818: HTTP over TLS (HTTPS)"; + } identity pop3 { - base layer-7-protocol; + base application-protocol; description "The identity for pop3."; reference "RFC 1939: Post Office Protocol - Version 3 (POP3)"; } - identity nat { - base layer-7-protocol; + identity imap { + base application-protocol; description - "The identity for nat."; + "The identity for Internet Message Access Protocol (IMAP)."; reference - "RFC 3022: Traditional IP Network Address Translator (Traditional - NAT)"; + "RFC 3501: INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1"; } identity action { description "Base identity for action"; } identity ingress-action { base action; description @@ -1153,27 +1161,27 @@ Functions - Forwarding action"; } identity transformation { base egress-action; description "Identity for transformation action capability"; reference "RFC 8329: Framework for Interface to Network Security Functions - Redirection action"; + } identity log-action { description - "Base identity for representing log actions, such as rule-log and - session-log action."; - + "Base identity for representing log actions, such as rule-log + and session-log action."; } identity rule-log { base log-action; description "Identity for rule log-action capability. Log the received packet based on the rule"; } identity session-log { @@ -1251,75 +1258,97 @@ base day; description "This represents Friday."; } identity saturday { base day; description "This represents Saturday."; } - identity sunday { base day; description "This represents Sunday."; } + identity continent { description - "Base Identity for continent types."; + "Base identity for continent types. The continents are based + on Encyclopedia Britannica"; + reference + "Encyclopedia Britannica: Continent"; } identity africa { base continent; description "Identity for Africa."; + reference + "Encyclopedia Britannica: Continent"; } identity asia { base continent; description "Identity for Asia."; + reference + "Encyclopedia Britannica: Continent"; + } + + identity antarctica { + base continent; + description + "Identity for Antarctica."; + reference + "Encyclopedia Britannica: Continent"; } identity europe { base continent; description "Identity for Europe."; + reference + "Encyclopedia Britannica: Continent"; } identity north-america { base continent; description "Identity for North America."; + reference + "Encyclopedia Britannica: Continent"; } identity south-america { base continent; description "Identity for South America."; + reference + "Encyclopedia Britannica: Continent"; } - identity oceania { + identity australia { base continent; description - "Identity for Oceania"; + "Identity for Australia"; + reference + "Encyclopedia Britannica: Continent"; } /* * Typedefs */ typedef time { type string { pattern '(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.\d+)?' + '(Z|[\+\-]((1[0-3]|0[0-9]):([0-5][0-9])|14:00))?'; - } description "The time type represents an instance of time of zero-duration that recurs every day."; } /* * Groupings */ @@ -1320,55 +1349,53 @@ } /* * Groupings */ grouping ipv4-list { description "Grouping for an IPv4 address list."; leaf-list ipv4 { - type inet:ipv4-address; + type inet:ipv4-address-no-zone; description "This is the entry for an IPv4 address list."; } } - grouping ipv6-list { description "Grouping for an IPv6 address list."; leaf-list ipv6 { - type inet:ipv6-address; + type inet:ipv6-address-no-zone; description "This is the entry for an IPv6 address list."; } } grouping ipv4 { description "Grouping for an IPv4 address."; leaf ipv4 { - type inet:ipv4-address; + type inet:ipv4-address-no-zone; description "This is the entry for an IPv4 address."; } } grouping ipv6 { description "Grouping for an IPv6 address."; leaf ipv6 { - type inet:ipv6-address; + type inet:ipv6-address-no-zone; description "This is the entry for an IPv6 address."; } - } grouping ip-address-info { description "There are two types to configure a security policy for an IP address, such as IPv4 adress and IPv6 address."; choice match-type { description "User can choose between IPv4 and IPv6."; case range-match-ipv4 { @@ -1367,57 +1394,56 @@ grouping ip-address-info { description "There are two types to configure a security policy for an IP address, such as IPv4 adress and IPv6 address."; choice match-type { description "User can choose between IPv4 and IPv6."; case range-match-ipv4 { container range-ipv4-address { leaf start-ipv4-address { - type inet:ipv4-address; + type inet:ipv4-address-no-zone; mandatory true; description "A start IPv4 address for a range match."; } leaf end-ipv4-address { - type inet:ipv4-address; + type inet:ipv4-address-no-zone; mandatory true; description "An end IPv4 address for a range match."; } description "A range match for IPv4 addresses is provided. Note that the start IPv4 address must be lower than the end IPv4 address."; } } case range-match-ipv6 { container range-ipv6-address { leaf start-ipv6-address { - type inet:ipv6-address; + type inet:ipv6-address-no-zone; mandatory true; description "A start IPv6 address for a range match."; } leaf end-ipv6-address { - type inet:ipv6-address; + type inet:ipv6-address-no-zone; mandatory true; description "An end IPv6 address for a range match."; } description "A range match for IPv6 addresses is provided. Note that the start IPv6 address must be lower than the end IPv6 address."; } - } } } grouping user-group { description "This group represents user group information such as name and ip-address."; leaf name { type string; @@ -1451,71 +1477,69 @@ description "This represents the name of a device-group."; } uses ip-address-info{ refine match-type{ mandatory true; } } leaf-list application-protocol { type identityref { - base layer-7-protocol; - + base application-protocol; } description "This represents the application layer protocols of devices. If this is not set, it cannot support the appropriate protocol"; } } grouping location-group { description - "This group represents location-group information such as geo-ip - and continent."; + "This group represents location-group information such as + geo-ip and continent."; leaf name { type string; description "This represents the name of a location."; } list geo-ip-ipv4 { key "ipv4-address"; description "This represents the list of IPv4 addresses based on a location."; leaf ipv4-address{ - type inet:ipv4-address; + type inet:ipv4-address-no-zone; description "This represents an IPv4 geo-ip address of a location."; } leaf ipv4-prefix{ type inet:ipv4-prefix; description "This represents the prefix for the IPv4 addresses."; } } list geo-ip-ipv6 { key "ipv6-address"; description "This represents the list of IPv6 addresses based on a location."; leaf ipv6-address{ - type inet:ipv6-address; + type inet:ipv6-address-no-zone; description "This represents an IPv6 geo-ip address of a location."; } leaf ipv6-prefix{ type inet:ipv6-prefix; description "This represents the prefix for the IPv6 addresses."; } - } leaf continent { type identityref { base continent; } default asia; description "location-group has geo-ip addresses of the corresponding continent."; } @@ -1516,48 +1540,49 @@ } default asia; description "location-group has geo-ip addresses of the corresponding continent."; } } grouping payload-string { description - "The grouping for payload-string content. It contains information - such as name and string content."; + "The grouping for payload-string content. It contains + information such as name and string content."; leaf description { type string; description - "This represents the description of a payload. If this is not - set, it cannot support the description of how the payload - content is related to a security attack."; + "This represents the description of a payload. If this is + not set, it cannot support the description of how the + payload content is related to a security attack."; } leaf-list content { type string; description "This represents the string of the payload contents. This content leaf-list contains the payload of a packet to analyze a threat. Due to the types of threats, the type of the content is defined as a string to accommodate any kind of a payload type such as HTTP, HTTPS, and SIP. If this is not set, it cannot support the payload contents involved in a security attack as a string."; } } list i2nsf-cfi-policy { key "policy-name"; description - "This is a security policy list. Each policy in the list contains - a list of security policy rules, and is a policy instance to have - the information of where and when a policy needs to be applied."; + "This is a security policy list. Each policy in the list + contains a list of security policy rules, and is a policy + instance to have the information of where and when a policy + needs to be applied."; leaf policy-name { type string; description "The name which identifies the policy."; } leaf resolution-strategy { type identityref { base resolution-strategy; } default fmr; @@ -1587,73 +1613,75 @@ range "1..255"; } description "The priority keyword comes with a mandatory numeric value which can range from 1 through 255. Note that a higher number means a higher priority"; } container event { description - "This represents an event (i.e., a security event), for which - a security rule is made."; + "This represents an event (i.e., a security event), for + which a security rule is made."; leaf security-event { type identityref { - base security-event-type; + base security-event; } description - "This contains the description of a security event. If this - is not set, it cannot support what security event will be - enforced."; + "This contains the description of a security event. If + this is not set, it cannot support what security event + will be enforced."; } + container time { description - "The time when a security policy rule should be applied."; + "The time when a security policy rule should be + applied."; leaf start-date-time { type yang:date-and-time; description "This is the start date and time for a security policy rule."; } leaf end-date-time { type yang:date-and-time; description "This is the end date and time for a policy rule. The policy rule will stop working after the specified end-date-time."; } container period{ when "../frequency!='only-once'"; description - "This represents the repetition time. In the case where - the frequency is weekly, the days can be set."; + "This represents the repetition time. In the case + where the frequency is weekly, the days can be set."; leaf start-time { type time; description "This is a period's start time for an event."; } leaf end-time { type time; description "This is a period's end time for an event."; } leaf-list day { when "../../frequency='weekly'"; type identityref{ base day; } min-elements 1; description - "This represents the repeated day of every week (e.g., - Monday and Tuesday). More than one day can be + "This represents the repeated day of every week + (e.g., Monday and Tuesday). More than one day can be specified."; } leaf-list date { when "../../frequency='monthly'"; type int32{ range "1..31"; } min-elements 1; description @@ -1716,59 +1743,63 @@ enforced."; } } } container condition { description "Conditions for general security policies."; container firewall-condition { description - "A general firewall condition based on the packet header."; + "A general firewall condition based on the packet + header."; leaf-list source { type union { type leafref { path - "/i2nsf-cfi-policy/endpoint-groups/user-group/name"; + "/i2nsf-cfi-policy/endpoint-groups/" + +"user-group/name"; } type leafref { path - "/i2nsf-cfi-policy/endpoint-groups/device-group/name"; + "/i2nsf-cfi-policy/endpoint-groups/" + +"device-group/name"; } } description "This describes the path of the source."; } leaf-list destination { type union { type leafref { path - "/i2nsf-cfi-policy/endpoint-groups/user-group/name"; + "/i2nsf-cfi-policy/endpoint-groups/" + +"user-group/name"; } type leafref { path - "/i2nsf-cfi-policy/endpoint-groups/device-group/name"; + "/i2nsf-cfi-policy/endpoint-groups/" + +"device-group/name"; } } description "This describes the path to the destinations."; } leaf transport-layer-protocol { type identityref { - base layer-4-protocol; + base transport-protocol; } description "The transport-layer protocol to be matched."; } - container range-port-number { leaf start-port-number { type inet:port-number; description "A start port number for range match."; } leaf end-port-number { type inet:port-number; description "An end port number for range match."; @@ -1767,23 +1798,23 @@ type inet:port-number; description "A start port number for range match."; } leaf end-port-number { type inet:port-number; description "An end port number for range match."; } description - "A range match for transport-layer port number. Note that - the start port number value must be lower than the end - port number value"; + "A range match for transport-layer port number. Note + that the start port number value must be lower than + the end port number value"; } list icmp { key "version"; description "Represents the ICMP packet header information to determine if the set of policy actions in this ECA policy rule should be executed or not."; reference "RFC 792: Internet Control Message Protocol @@ -1845,48 +1877,48 @@ container ddos-condition { description "A condition for a DDoS attack."; container rate-limit { description "This describes the rate-limit."; leaf packet-rate-threshold { type uint32; description - "This is a trigger value for a rate limit of packet rate - for a DDoS-attack mitigation."; + "This is a trigger value for a rate limit of packet + rate for a DDoS-attack mitigation."; } leaf byte-rate-threshold { type uint32; description - "This is a trigger value for a rate limit of byte rate - for a DDoS-attack mitigation."; + "This is a trigger value for a rate limit of byte + rate for a DDoS-attack mitigation."; } leaf flow-rate-threshold { type uint32; description - "This is a trigger value for a rate limit of flow rate - for a DDoS-attack mitigation."; + "This is a trigger value for a rate limit of flow + rate for a DDoS-attack mitigation."; } } } container anti-virus-condition { description "A condition for anti-virus"; leaf-list exception-files { type string; description "The type or name of the files to be excluded by the - anti-virus. This can be used to keep the known harmless - files."; + anti-virus. This can be used to keep the known + harmless files."; } } container payload-condition { description "A condition based on a packet's content."; leaf-list content { type leafref { path "/i2nsf-cfi-policy/threat-preventions/" + "payload-content/name"; @@ -1887,29 +1919,30 @@ description "A condition based on a packet's content."; leaf-list content { type leafref { path "/i2nsf-cfi-policy/threat-preventions/" + "payload-content/name"; } description "This describes the paths to a packet content's"; } - } container url-condition { description "Condition for url category"; leaf url-name { type leafref { - path "/i2nsf-cfi-policy/endpoint-groups/url-group/name"; + path + "/i2nsf-cfi-policy/endpoint-groups/" + +"url-group/name"; } description "This is description for the condition of a URL's category such as SNS sites, game sites, ecommerce sites, company sites, and university sites."; } } container voice-condition { description @@ -1943,36 +1976,38 @@ leaf-list user-agent { type string; description "The security policy rule according to an user agent for VoIP and VoLTE."; } } container context-condition { description - "Condition for matching the context of the packet, such as - geographic location, time, packet direction"; + "Condition for matching the context of the packet, such + as geographic location, time, packet direction"; container geography-location-condition { description "A condition for a location-based connection"; leaf-list source { type leafref { - path "/i2nsf-cfi-policy/endpoint-groups/" + path + "/i2nsf-cfi-policy/endpoint-groups/" + "location-group/name"; } description "This describes the paths to a location's sources."; } leaf-list destination { type leafref { - path "/i2nsf-cfi-policy/endpoint-groups/" + path + "/i2nsf-cfi-policy/endpoint-groups/" + "location-group/name"; } description "This describes the paths to a location's destinations."; } } } container threat-feed-condition { @@ -2065,52 +2102,54 @@ } } } container threat-preventions { description "This describes the list of threat-preventions."; list threat-feed-list { key "name"; description - "There can be a single or multiple number of threat-feeds."; + "There can be a single or multiple number of + threat-feeds."; leaf name { type string; description "This represents the name of the threat-feed."; } leaf description { type string; description "This represents the descriptions of a threat-feed. The description should include information, such as type, threat, method, and file type. Structured Threat - Information Expression (STIX) can be used for description - of a threat [STIX]."; + Information Expression (STIX) can be used for + description of a threat [STIX]."; } leaf-list signatures { type identityref { base signature-type; } description "This contains a list of signatures or hashes of the threats."; + } } list payload-content { key "name"; leaf name { type string; description - "This represents the name of a packet's payload-content. It - should give an idea of why a specific payload content is - marked as a threat. For example, the name 'backdoor' + "This represents the name of a packet's payload-content. + It should give an idea of why a specific payload content + is marked as a threat. For example, the name 'backdoor' indicates the payload content is related to a backdoor attack."; } description "This represents a payload-string group."; uses payload-string; } } } } @@ -2467,28 +2506,65 @@ name: ietf-i2nsf-cfi-policy namespace: urn:ietf:params:xml:ns:yang:ietf-i2nsf-cfi-policy prefix: nsfcfi reference: RFC XXXX // RFC Ed.: replace XXXX with an actual RFC number and remove // this note. 11. Security Considerations - The data model for the I2NSF Consumer-Facing Interface is based on - the I2NSF framework [RFC8329], so the same security considerations - with the I2NSF framework should be included in this document. The - data model needs a secure communication channel to protect the - Consumer-Facing Interface between the I2NSF User and Security - Controller. Also, the data model's management access control is - based on Network Configuration Access Control Model(NACM) mechanisms - [RFC8341]. + The YANG module specified in this document defines a data schema + designed to be accessed through network management protocols such as + NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is + the secure transport layer, and the required secure transport is + Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, + and the required secure transport is TLS [RFC8446]. + + The Network Configuration Access Control Model (NACM) [RFC8341] + provides a means of restricting access to specific NETCONF or + RESTCONF users to a preconfigured subset of all available NETCONF or + RESTCONF protocol operations and contents. Thus, NACM SHOULD be used + to restrict the NSF registration from unauthorized users. + + There are a number of data nodes defined in this YANG module that are + writable, creatable, and deletable (i.e., config true, which is the + default). These data nodes may be considered sensitive or vulnerable + in some network environments. Write operations to these data nodes + could have a negative effect on network and security operations. + These data nodes are collected into a single list node with the + following sensitivity/vulnerability: + + * list i2nsf-cfi-policy: Writing to almost any element of this YANG + module would directly impact on the configuration of NSFs, e.g., + completely turning off security monitoring and mitigation + capabilities; altering the scope of this monitoring and + mitigation; creating an overwhelming logging volume to overwhelm + downstream analytics or storage capacity; creating logging + patterns which are confusing; or rendering useless trained + statistics or artificial intelligence models. + + Some of the readable data nodes in this YANG module may be considered + sensitive or vulnerable in some network environments. It is thus + important to control read access (e.g., via get, get-config, or + notification) to these data nodes. These are the subtrees and data + nodes with their sensitivity/vulnerability: + + * list i2nsf-cfi-policy: The leak of this node to an attacker could + reveal the specific configuration of security controls to an + attacker. An attacker can craft an attack path that avoids + observation or mitigations; one may reveal topology information to + inform additional targets or enable lateral movement; one enables + the construction of an attack path that avoids observation or + mitigations; one provides an indication that the operator has + discovered the attack. This node also holds a list of endpoint + data that is considered private to the users. 12. Acknowledgments This work was supported by Institute of Information & Communications Technology Planning & Evaluation (IITP) grant funded by the Korea MSIT (Ministry of Science and ICT) (R-20160222-002755, Cloud based Security Intelligence Technology Development for the Customized Security Service Provisioning). This work was supported in part by the IITP (2020-0-00395, Standard Development of Blockchain based Network Management Automation Technology). @@ -2533,55 +2610,92 @@ Senad Palislamovic Nokia 755 Ravendale Drive Mountain View, CA 94043 US EMail: senad.palislamovic@nokia.com Liang Xia Huawei 101 Software Avenue Nanjing, Jiangsu 210012 China EMail: Frank.Xialiang@huawei.com 14. References 14.1. Normative References + [RFC0768] Postel, J., "User Datagram Protocol", STD 6, RFC 768, + DOI 10.17487/RFC0768, August 1980, + . + + [RFC0792] Postel, J., "Internet Control Message Protocol", STD 5, + RFC 792, DOI 10.17487/RFC0792, September 1981, + . + + [RFC0793] Postel, J., "Transmission Control Protocol", STD 7, + RFC 793, DOI 10.17487/RFC0793, September 1981, + . + [RFC0854] Postel, J. and J. Reynolds, "Telnet Protocol Specification", STD 8, RFC 854, DOI 10.17487/RFC0854, May 1983, . [RFC0959] Postel, J. and J. Reynolds, "File Transfer Protocol", STD 9, RFC 959, DOI 10.17487/RFC0959, October 1985, . [RFC1939] Myers, J. and M. Rose, "Post Office Protocol - Version 3", STD 53, RFC 1939, DOI 10.17487/RFC1939, May 1996, . [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . + [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, + A., Peterson, J., Sparks, R., Handley, M., and E. + Schooler, "SIP: Session Initiation Protocol", RFC 3261, + DOI 10.17487/RFC3261, June 2002, + . + + [RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION + 4rev1", RFC 3501, DOI 10.17487/RFC3501, March 2003, + . + [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC4250] Lehtinen, S. and C. Lonvick, Ed., "The Secure Shell (SSH) Protocol Assigned Numbers", RFC 4250, DOI 10.17487/RFC4250, January 2006, . + [RFC4340] Kohler, E., Handley, M., and S. Floyd, "Datagram + Congestion Control Protocol (DCCP)", RFC 4340, + DOI 10.17487/RFC4340, March 2006, + . + + [RFC4443] Conta, A., Deering, S., and M. Gupta, Ed., "Internet + Control Message Protocol (ICMPv6) for the Internet + Protocol Version 6 (IPv6) Specification", STD 89, + RFC 4443, DOI 10.17487/RFC4443, March 2006, + . + [RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321, DOI 10.17487/RFC5321, October 2008, . [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, . + [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure + Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, + . + [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, . [RFC7230] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing", RFC 7230, DOI 10.17487/RFC7230, June 2014, . [RFC7231] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer @@ -2608,25 +2722,36 @@ [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, . [RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of Documents Containing YANG Data Models", BCP 216, RFC 8407, DOI 10.17487/RFC8407, October 2018, . + [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol + Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, + . + [RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K., and R. Wilton, "YANG Library", RFC 8525, DOI 10.17487/RFC8525, March 2019, . + [I-D.ietf-tcpm-rfc793bis] + Eddy, W. M., "Transmission Control Protocol (TCP) + Specification", Work in Progress, Internet-Draft, draft- + ietf-tcpm-rfc793bis-25, 7 September 2021, + . + 14.2. Informative References [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, DOI 10.17487/RFC2818, May 2000, . [RFC3022] Srisuresh, P. and K. Egevang, "Traditional IP Network Address Translator (Traditional NAT)", RFC 3022, DOI 10.17487/RFC3022, January 2001, . @@ -2656,44 +2781,59 @@ Feeds", RFC 8805, DOI 10.17487/RFC8805, August 2020, . [I-D.ietf-i2nsf-capability] Xia, L., Strassner, J., Basile, C., and D. R. Lopez, "Information Model of NSFs Capabilities", Work in Progress, Internet-Draft, draft-ietf-i2nsf-capability-05, 24 April 2019, . + [IANA-ICMP-Parameters] + Internet Assigned Numbers Authority (IANA), "Assigned + Internet Protocol Numbers", February 2021, + . + + [IANA-ICMPv6-Parameters] + Internet Assigned Numbers Authority (IANA), "Internet + Control Message Procotol version 6 (ICMPv6) Parameters", + February 2021, . + + [Encyclopedia-Britannica] + Britannica, "Continent", September 2020, + . + [YARA] Alvarez, V., Bengen, H., Metz, J., Buehlmann, S., and W. Shields, "YARA", YARA Documents https://yara.readthedocs.io/en/v3.5.0/, August 2020. [SURICATA] Julien, V. and , "SURICATA", SURICATA Documents https://suricata-ids.org/docs/, August 2020. [SNORT] Roesch, M., Green, C., and B. Caswell, "SNORT", SNORT Documents https://www.snort.org/#documents, August 2020. [STIX] Jordan, B., Piazza, R., and T. Darley, "Structured Threat Information Expression (STIX)", STIX Version 2.1: Committee Specification 01 https://docs.oasis- open.org/cti/stix/v2.1/stix-v2.1.pdf, March 2020. Appendix A. Changes from draft-ietf-i2nsf-consumer-facing-interface- - dm-13 + dm-14 The following changes are made from draft-ietf-i2nsf-consumer-facing- - interface-dm-13: + interface-dm-14: - * This version has been updated to synchronize with other I2NSF - documents. + * This version has been updated following Tom Petch's comments. Authors' Addresses Jaehoon (Paul) Jeong (editor) Department of Computer Science and Engineering Sungkyunkwan University 2066 Seobu-Ro, Jangan-Gu Suwon Gyeonggi-Do 16419