--- 1/draft-ietf-i2nsf-consumer-facing-interface-dm-08.txt 2020-07-13 06:13:40.778855771 -0700 +++ 2/draft-ietf-i2nsf-consumer-facing-interface-dm-09.txt 2020-07-13 06:13:40.874858189 -0700 @@ -1,24 +1,24 @@ I2NSF Working Group J. Jeong Internet-Draft C. Chung Intended status: Standards Track Sungkyunkwan University -Expires: September 12, 2020 T. Ahn +Expires: January 14, 2021 T. Ahn Korea Telecom R. Kumar Juniper Networks S. Hares Huawei - March 11, 2020 + July 13, 2020 I2NSF Consumer-Facing Interface YANG Data Model - draft-ietf-i2nsf-consumer-facing-interface-dm-08 + draft-ietf-i2nsf-consumer-facing-interface-dm-09 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 organized based on the "Event-Condition-Action" @@ -36,21 +36,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 September 12, 2020. + This Internet-Draft will expire on January 14, 2021. Copyright Notice Copyright (c) 2020 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 @@ -62,48 +62,51 @@ Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Requirements Language . . . . . . . . . . . . . . . . . . . . 5 3. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 5 4. Information Model for Policy . . . . . . . . . . . . . . . . 5 4.1. Event Sub-model . . . . . . . . . . . . . . . . . . . . . 7 4.2. Condition Sub-model . . . . . . . . . . . . . . . . . . . 8 4.3. Action Sub-model . . . . . . . . . . . . . . . . . . . . 9 - 5. Information Model for Policy Endpoint Groups . . . . . . . . 10 + 5. Information Model for Policy Endpoint Groups . . . . . . . . 9 5.1. User Group . . . . . . . . . . . . . . . . . . . . . . . 10 5.2. Device Group . . . . . . . . . . . . . . . . . . . . . . 11 5.3. Location Group . . . . . . . . . . . . . . . . . . . . . 12 6. Information Model for Threat Prevention . . . . . . . . . . . 13 6.1. Threat Feed . . . . . . . . . . . . . . . . . . . . . . . 13 6.2. Payload Content . . . . . . . . . . . . . . . . . . . . . 14 - 7. Network Configuration Access Control Model (NACM) . . . . . . 15 - 8. YANG Data Model of Consumer-Facing Interface . . . . . . . . 15 + 7. Network Configuration Access Control Model (NACM) for I2NSF + Consumer-Facing Interface . . . . . . . . . . . . . . . . . . 15 + 8. YANG Data Model of Consumer-Facing Interface . . . . . . . . 17 9. XML Configuration Examples of High-Level Security Policy - Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 + Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 9.1. Database Registration: Information of Positions and - Devices (Endpoint Group) . . . . . . . . . . . . . 36 - 9.2. Scenario 1: Block SNS Access during Business Hours . . . 37 + Devices (Endpoint Group) . . . . . . . . . . . . . . . . 40 + 9.2. Scenario 1: Block SNS Access during Business Hours . . . 41 9.3. Scenario 2: Block Malicious VoIP/VoLTE Packets Coming to - a Company . . . . . . . . . . . . . . . . . . . . . . . . 39 + a Company . . . . . . . . . . . . . . . . . . . . . . . . 43 9.4. Scenario 3: Mitigate HTTP and HTTPS Flood Attacks on a - Company Web Server . . . . . . . . . . . . . . . . . . . 40 - 10. Security Considerations . . . . . . . . . . . . . . . . . . . 42 - 11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 42 - 12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 42 - 13. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 42 - 14. References . . . . . . . . . . . . . . . . . . . . . . . . . 44 - 14.1. Normative References . . . . . . . . . . . . . . . . . . 44 - 14.2. Informative References . . . . . . . . . . . . . . . . . 45 + Company Web Server . . . . . . . . . . . . . . . . . . . 45 + 10. XML Configuration Example of a User Group's Access Control + for I2NSF Consumer-Facing Interface . . . . . . . . . . . . . 46 + 11. Security Considerations . . . . . . . . . . . . . . . . . . . 48 + 12. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 48 + 13. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 48 + 14. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 48 + 15. References . . . . . . . . . . . . . . . . . . . . . . . . . 51 + 15.1. Normative References . . . . . . . . . . . . . . . . . . 51 + 15.2. Informative References . . . . . . . . . . . . . . . . . 52 Appendix A. Changes from draft-ietf-i2nsf-consumer-facing- - interface-dm-07 . . . . . . . . . . . . . . . . . . 47 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 47 + interface-dm-08 . . . . . . . . . . . . . . . . . . 53 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 53 1. Introduction In a framework of Interface to Network Security Functions (I2NSF), 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 communicate using @@ -206,89 +209,74 @@ 4. Information Model for Policy A Policy object represents a mechanism to express a Security Policy by Security Administrator (i.e., I2NSF User) using Consumer-Facing Interface toward Security Controller; the policy would be enforced on an NSF. Figure 2 shows the YANG tree of the Policy object. The Policy object SHALL have the following information: Name: This field identifies the name of this object. - Owners: This field contains the owners of the policy. For - example, the owners who created it, and can modify it. - This field represents multiple groups owning as owners, - having full CRUD privileges by default. Note that it is - assumed that a factory-default owner (e.g., root) is - defined and preconfigured in Security Controller in order - to create new policy objects at first. - Rule: This field contains a list of rules. These rules are defined for 1) communication between two Endpoint Groups, 2) for preventing communication with externally or internally identified threats, and 3) for implementing business requirement such as controlling access to internal or external resources for meeting regulatory compliance or business objectives. An organization may restrict certain communication between a set of user and applications for example. The threats may be from threat feeds obtained from external sources or dynamically identified by using specialty devices in the network. Rule conflict analysis should be triggered by the monitoring service to perform an exhaustive detection of anomalies among the configuration rules installed into the security functions. +--rw i2nsf-cfi-policy* [policy-name] +--rw policy-name string - | uses owners-ref - | +--rw rules* [rule-name] + +--rw rules +--rw endpoint-groups +--rw threat-prevention Figure 2: Policy YANG Data Tree A policy is a container of Rule(s). In order to express a Rule, a Rule must have complete information such as where and when a policy needs to be applied. This is done by defining a set of managed objects and relationship among them. A Policy Rule may be related segmentation, threat mitigation or telemetry data collection from an NSF in the network, which will be specified as the sub-model of the policy model in the subsequent sections. Figure 3 shows the YANG data tree of the Rule object. The rule object SHALL have the following information: Name: This field identifies the name of this object. - Owners: This field contains the owners of the rule. For example, - the owners who created it, and can modify it. This field - represents multiple groups owning as owners, having full - CRUD privileges by default. - Event: This field includes the information to determine whether the Rule Condition can be evaluated or not. See details in Section 4.1. Condition: This field contains all the checking conditions to apply to the objective traffic. See details in Section 4.2. 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. IPsec-Method: This field contains the information about IPsec method type. There are two types such as IPsec-IKE and IPsec-IKEless [i2nsf-ipsec]. +--rw rules* [rule-name] +--rw rule-name string - | uses owners-ref +--rw event +--rw (condition)? +--rw action +--rw ipsec-method 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" [i2nsf-capability-im]. @@ -297,42 +285,45 @@ The Event Object contains information related to scheduling a Rule. The Rule could be activated based on a set time or security event. Figure 4 shows the YANG tree of the Event object. Event object SHALL have following information: Security-event: This field identifies for which security event the policy is enforced. The examples of security events are: "DDOS", "spyware", "trojan", and "ransomware". - Enforce-type: This field identifies whether the event of - triggering policy enforcement is "Admin" or "Time". + Time-information: This represents the security rule is enforced + based on the period information with the end time for the + event. - Admin: This represents the enforcement type based on admin's - decision. + Period: This represents the period of time the rule event is + active. - Time: This represents the security rule is enforced based on - begin-time and end-time information. + End-time: This represents the end time of the event. If the rule + time has pass the end-time, the rule will stop repeating" Frequency: This represents how frequent the rule should be enforced. There are four options: "only-once", "daily", "weekly" and "monthly". +--rw event +--rw security-event identityref - +--rw (enforce-type)? - | +--:(admin) - | | +--rw admin? - | +--:(time) - | +--rw time-information - | +--rw begin-time? date-and-time - | +--rw end-time? date-and-time + +--rw time-information + | +--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 day* identityref + | | +--rw date* int32 + | | +--rw month* string +--rw frequency? enumeration Figure 4: Event Sub-model YANG Data Tree 4.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 @@ -369,34 +360,38 @@ obtained from threat-feeds (e.g., Palo-Alto, or RSA- netwitness). This information is useful when security rule condition is based on the existing threat reports gathered by other sources. The source and destination is represented as threat-feed-source and threat-feed- destination. For clarity, threat-feed-source/destination represent the source/destination of a target security threat, not the information source/destination of a threat- feed. - +--rw (condition)? - +--:(firewall-condition) - | +--rw source -> /../../nacm:group/nacm:user-name - | +--rw dest-target* -> /../../nacm:group/nacm:user-name - +--:(ddos-condition) + +--rw condition + +--:firewall-condition + | +--rw source -> /../../user-group/name + | +--rw destination* -> /../../user-group/name + +--:ddos-condition | +--rw source* -> /../../device-group/name - | +--rw dest-target* -> /../../device-group/name + | +--rw destination* -> /../../device-group/name | +--rw rate-limit - +--:(custom-condition) + | +--rw packet-threshold-per-second? uint32 + +--:location-condition + | +--rw source* -> /../../location-group/name + | +--rw destination -> /../../location-group/name + +--:custom-condition | +--rw source* -> /../../payload-content/name - | +--rw dest-target -> /../../payload-content/name - +--:(threat-feed-condition) + | +--rw destination -> /../../payload-content/name + +--:threat-feed-condition +--rw source* -> /../../threat-feed-list/name - +--rw dest-target -> /../../threat-feed-list/name + +--rw destination -> /../../threat-feed-list/name Figure 5: Condition Sub-model YANG Data Tree 4.3. Action Sub-model This object represents actions that Security Admin wants to perform based on certain traffic class. Figure 6 shows the YANG tree of the Action object. The Action object SHALL have following information: Primary-action: This field identifies the action when a rule is @@ -431,26 +426,26 @@ | +--------------+----------------+ 1..n | 1..n | 1..n | +-----+----+ +------+-----+ +-------+------+ |User-group| |Device-group| |Location-group| +----------+ +------------+ +--------------+ Figure 7: Endpoint Group Diagram +--rw endpoint-groups - +--rw user-group* [name] - ... - +--rw device-group* [name] - ... - +--rw location-group* [name] - ... + | +--rw user-group* [name] + | ... + | +--rw device-group* [name] + | ... + | +--rw location-group* [name] + | ... Figure 8: Endpoint Group YANG Data Tree 5.1. User Group This object represents a User-Group. Figure 9 shows the YANG tree of the User-Group object. The User-Group object SHALL have the following information: Name: This field identifies the name of this object. @@ -458,34 +453,32 @@ IP-address: This represents the IPv4 address of a user in the user group. range-ipv4-address: This represents the IPv4 address of a user in the user gorup. range-ipv6-address: This represents the IPv6 address of a user in the user gorup. +--rw user-group* [name] - +--rw name -> /../../nacm:group/nacm:user-name - +--rw (match-type)? + +--rw name string + +--rw (match-type) +--:(exact-match-ipv4) - | +--rw ipv4-address* inet:ipv4-address + | +--rw ipv4? inet:ipv4-address +--:(exact-match-ipv6) - | +--rw ipv6-address* inet:ipv6-address + | +--rw ipv6? inet:ipv6-address +--:(range-match-ipv4) - | +--rw range-ipv4-address* - [start-ipv4-address end-ipv4-address] + | +--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* - [start-ipv6-vaddress end-ipv6-address] +--rw start-ipv6-address inet:ipv6-address +--rw end-ipv6-address inet:ipv6-address Figure 9: User Group YANG Data Tree 5.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: @@ -500,35 +493,33 @@ range-ipv6-address: This represents the IPv6 address of a device in the device gorup. Protocol: This represents the communication protocols used by the devices. The protocols are "SSH", "FTP", "SMTP", "HTTP", "HTTPS", and etc. +--rw device-group* [name] +--rw name string - +--rw (match-type)? + +--rw (match-type) | +--:(exact-match-ipv4) - | | +--rw ipv4-address* inet:ipv4-address + | | +--rw ipv4? inet:ipv4-address | +--:(exact-match-ipv6) - | | +--rw ipv6-address* inet:ipv6-address + | | +--rw ipv6? inet:ipv6-address | +--:(range-match-ipv4) | | +--rw range-ipv4-address* - [start-ipv4-address end-ipv4-address] - | | +--rw start-ipv4-address inet:ipv4-address - | | +--rw end-ipv4-address inet:ipv4-address + | | | +--rw start-ipv4-address inet:ipv4-address + | | | +--rw end-ipv4-address inet:ipv4-address | +--:(range-match-ipv6) - | +--rw range-ipv6-address* - [start-ipv6-vaddress end-ipv6-address] - | +--rw start-ipv6-address inet:ipv6-address - | +--rw end-ipv6-address inet:ipv6-address + | | +--rw range-ipv6-address* + | | | +--rw start-ipv6-address inet:ipv6-address + | | | +--rw end-ipv6-address inet:ipv6-address +--rw protocol identityref Figure 10: Device Group YANG Data Tree 5.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: @@ -637,44 +628,96 @@ Content: This contains the payload contents, which are involed in a security attack, as strings. +--rw payload-content* [name] +--rw name string +--rw description string +--rw content* string Figure 15: Payload Content in YANG Data Tree -7. Network Configuration Access Control Model (NACM) +7. Network Configuration Access Control Model (NACM) for I2NSF + Consumer-Facing Interface - Network Configuration Access Control Model (NACM) provides a high- - level overview of the access control with the following features - [RFC8341]: + Network Configuration Access Control Model (NACM) provides a user + group with an access control with the following features [RFC8341]: o Independent control of action, data, and notification access is provided. o A simple and familiar set of datastore permissions is used. o Support for YANG security tagging allows default security modes to automatically exclude sensitive data. o Separate default access modes for read, write, and execute permissions are provided. o Access control rules are applied to configurable groups of users. - The data model for the I2NSF Consumer-Facing Interface provides NACM - mechanisms and concepts to user-group and owners permissions. The - NACM with the above features can be used to set up all the management - access controls in the I2NSF high-level authorization view, and it - may have a high impact on the optimization and performance. + The data model of the I2NSF Consumer-Facing Interface utilizes the + NACM's mechanisms to manage the access control on the I2NSF Consumer- + Facing Interface. The NACM with the above features can be used to + set up the access control rules of a user group in the I2NSF + Consumer-Facing Interface. Figure 16 shows part of the NACM module + to enable the access control of a user group for the I2NSF Consumer- + Facing Interface. To use the NACM, a user needs to configure a + NETCONF or RESTCONF server to enable the NACM module. Then, the user + can simply use an account of root or admin user for the access + control for the module of the I2NSF Consumer-Facing Interface (i.e., + ietf-i2nsf-cfi-policy). An XML example to configure the access + control a user group for the I2NSF Consumer-Facing Interface can be + seen in Section 10. + + list rule { + key "name"; + ordered-by user; + leaf name { + type string { + length "1..max"; + } + description + "Arbitrary name assigned to the rule."; + } + + leaf module-name { + type union { + type matchall-string-type; + type string; + } + default "*"; + description + "Name of the module associated with this rule." + } + + leaf access-operations { + type union { + type matchall-string-type; + type access-operations-type; + } + default "*"; + description + "Access operations associated with this rule." + } + + leaf action { + type action-type; + mandatory true; + description + "The access control action associated with the + rule. If a rule is determined to match a + particular request, then this object is used + to determine whether to permit or deny the + request."; + } + + Figure 16: A Part of the NACM YANG Data Model 8. YANG Data Model of Consumer-Facing Interface The main objective of this data model is to provide both an information model and the corresponding YANG data model of I2NSF Consumer-Facing Interface. This interface can be used to deliver control and management messages between an I2NSF User and Security Controller for the I2NSF User's high-level security policies. The semantics of the data model must be aligned with the information @@ -687,32 +730,34 @@ be extended according to the security needs. In other words, the model design is independent of the content and meaning of specific policies as well as the implementation approach. This document suggests a VoIP/VoLTE security service as a use case for policy rule generation. This section describes a YANG data model for Consumer-Facing Interface, based on the information model of Consumer-Facing Interface to Security Controller. - file "ietf-i2nsf-cfi-policy@2020-03-11.yang" - + file "ietf-i2nsf-cfi-policy@2020-07-13.yang" module ietf-i2nsf-cfi-policy { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-i2nsf-cfi-policy"; prefix - cfi-policy; + i2nsf-cfi; import ietf-inet-types{ prefix inet; - reference "Section 4 of RFC 6991"; + } + + import ietf-yang-types{ + prefix yang; } import ietf-netconf-acm { prefix nacm; } organization "IETF I2NSF (Interface to Network Security Functions) Working Group"; @@ -733,28 +779,28 @@ description "This module is a YANG module for Consumer-Facing Interface. Copyright (c) 2020 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents - (http://trustee.ietf.org/license-info). + http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; - revision "2020-03-11"{ + revision "2020-07-13"{ description "The latest revision"; reference - "draft-ietf-consumer-facing-interface-dm-07"; + "draft-ietf-consumer-facing-interface-dm-08"; } identity malware-file-type { description "Base identity for malware file types."; } identity executable-file { base malware-file-type; description @@ -796,41 +842,43 @@ description "Identity for Microsoft installer file types."; } identity security-event-type { description "Base identity for security event types."; } identity ddos { + base security-event-type; description "Identity for DDoS event types."; } identity spyware { - base malware-file-type; + base security-event-type; description "Identity for spyware event types."; } identity trojan { - base malware-file-type; + base security-event-type; description "Identity for Trojan infection event types."; } identity ransomware { - base malware-file-type; + base security-event-type; description "Identity for ransomware infection event types."; } + identity i2nsf-ipsec { description "Base identity for IPsec method types."; reference "draft-ietf-i2nsf-sdn-ipsec-flow-protection-07"; } identity ipsec-ike { base i2nsf-ipsec; description @@ -881,36 +928,20 @@ description "Identity for south-america."; } identity oceania { base continent; description "Identity for Oceania"; } - identity enforce-type { - description - "This identity represents the event of - policy enforcement trigger type."; - } - - identity admin { - description - "The identity for policy enforcement by admin."; - } - - identity time { - description - "The identity for policy enforcement based on time."; - } - identity protocol-type { description "This identity represents the protocol types."; } identity ftp { base protocol-type; description "The identity for ftp protocol."; reference @@ -1056,39 +1088,83 @@ base signature-type; description "This represents the SNORT signatures."; } identity signature-suricata { base signature-type; description "This represents the SURICATA signatures."; } + identity threat-feed-type { description "This represents the base identity for threat-feed."; } + identity day { + description + "This represents the base for days."; + } + + identity monday { + base day; + description + "This represents monday."; + } + + identity tuesday { + base day; + description + "This represents tuesday."; + } + + identity wednesday { + base day; + description + "This represents wednesday."; + } + + identity thursday { + base day; + description + "This represents thursday."; + } + + identity friday { + base day; + description + "This represents friday."; + } + + identity saturday { + base day; + description + "This represents saturday."; + } + + identity sunday { + base day; + description + "This represents sunday."; + } + /* * Typedefs */ - typedef date-and-time { + typedef time{ type string { - pattern '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?' + pattern '\d{2}:\d{2}:\d{2}(\.\d+)?' + '(Z|[\+\-]\d{2}:\d{2})'; } description - "This is the format of date-and-time."; - reference - "RFC 3339: Date and Time on the Internet: Timestamps - RFC 2579: Textual Conventions for SMIv2 - XSD-TYPES: XML Schema Part 2: Datatypes Second Edition"; + "This is the format of time."; } /* * Groupings */ grouping ipv4-list { description "Grouping for ipv4 based ip-addresses."; leaf-list ipv4 { @@ -1140,39 +1216,37 @@ uses ipv4; description "Exact ip-address match for ipv4 type addresses"; } case exact-match-ipv6 { uses ipv6; description "Exact ip-address match for ipv6 type addresses"; } case range-match-ipv4 { - list range-ipv4-address { - key "start-ipv4-address end-ipv4-address"; + container range-ipv4-address { leaf start-ipv4-address { type inet:ipv4-address; description "Start IPv4 address for a range match."; } leaf end-ipv4-address { type inet:ipv4-address; description "End IPv4 address for a range match."; } description "Range match for an IP-address."; } } case range-match-ipv6 { - list range-ipv6-address { - key "start-ipv6-address end-ipv6-address"; + container range-ipv6-address { leaf start-ipv6-address { type inet:ipv6-address; description "Start IPv6 address for a range match."; } leaf end-ipv6-address { type inet:ipv6-address; description "End IPv6 address for a range match."; } @@ -1199,41 +1273,54 @@ If this is not set, it cannot support IPsec IKE or IPsec IKEless."; reference "draft-ietf-i2nsf-sdn-ipsec-flow-protection-07"; } } } grouping user-group { description - "The grouping for user-group entities, and - contains information such as name & ip-address."; - + "The grouping for user-group entities, and contains + information such as name & ip-address."; leaf name { type string; description - "This represents the name of a user."; + "This represents the name of a user-group. + A user-group name is used to map a user-group's + name (e.g., employees) to an ip address. + It is implementation dependent"; + + } + uses ip-address-info{ + refine match-type{ + mandatory true; + } + description + "This represent the IP address of a user-group."; } - uses ip-address-info; } grouping device-group { description "This group represents device group information such as ip-address protocol."; leaf name { type string; description - "This represents the name of a device."; + "This represents the name of a device-group."; + } + uses ip-address-info{ + refine match-type{ + mandatory true; + } } - uses ip-address-info; leaf-list protocol { type identityref { base protocol-type; } description "This represents the communication protocols of devices. If this is not set, it cannot support the appropriate protocol"; } @@ -1241,68 +1328,91 @@ grouping location-group { description "This group represents location-group information such as geo-ip and continent."; leaf name { type string; description "This represents the name of a location."; } - leaf geo-ip-ipv4 { + list geo-ip-ipv4 { + key "ipv4-address"; + description + "This represents the list of IPv4 address based on + a location."; + leaf ipv4-address{ type inet:ipv4-address; description - "This represents the IPv4 geo-ip of a location."; + "This represents an IPv4 geo-ip of a location."; } - leaf geo-ip-ipv6 { + leaf ipv4-prefix{ + type inet:ipv4-prefix; + description + "This represents the prefix for the IPv4-address."; + } + } + list geo-ip-ipv6 { + key "ipv6-address"; + description + "This represents the list of IPv6 address based on + a location."; + leaf ipv6-address{ type inet:ipv6-address; description - "This represents the IPv6 geo-ip of a location."; - + "This represents an IPv6 geo-ip of a location."; + } + leaf ipv6-prefix{ + type inet:ipv6-prefix; + description + "This represents the prefix for the IPv6-address."; + } } leaf continent { type identityref { base continent; } default asia; description "location-group-based on geo-ip of respective continent."; } } grouping threat-feed-info { description "This is the grouping for the threat-feed-list"; - leaf name { + leaf threat-type { type identityref { base threat-feed-type; } description - "This represents the name of the a threat-feed."; + "This represents the type of the threat-feed."; } leaf server-ipv4 { type inet:ipv4-address; description "The IPv4 ip-address for the threat-feed server."; } leaf server-ipv6 { type inet:ipv6-address; description "The IPv6 ip-address for the threat-feed server."; } leaf description { type string; description "This represents the descriptions of a threat-feed. The description should include information, such as - the type, related threat, method, and file type."; + the type, related threat, method, and file type. + Structured Threat Information Expression (STIX) can + be used for description of a threat [STIX]."; } } grouping payload-string { description "The grouping for payload-string content. It contains information such as name and string content."; leaf description { type string; @@ -1321,249 +1431,305 @@ Due to the types of threats, the type of the content is defined as 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 strings"; } } - grouping owners-ref { - description - "This grouping is for owners reference using - Network Configuration Access Control Model - (NACM)."; - leaf-list owners { - type leafref { - path "/nacm:nacm/nacm:groups/nacm:group/nacm:name"; - } - description - "This leaf-list names the owner groups of the - list instance it sits on. Only the owners listed - in a NACM group are authorized to get full CRUD - privileges for the contents. - If this is not set, it cannot support who has - the prvilege of the contents"; - } - } - list i2nsf-cfi-policy { key "policy-name"; description "This is the security policy list. Each policy in the list contains a list of security rules, and is a policy instance to have complete information such as where and when a policy needs to be applied."; leaf policy-name { type string; - mandatory true; description - "The name which identifies the policy."; - } - uses owners-ref; - + "The name which identifies the policy."; } container rules{ description "This container is for rules."; nacm:default-deny-write; list rule { key "rule-name"; ordered-by user; leaf rule-name { type string; - mandatory true; description "This represents the name for the rule."; } description "There can be a single or multiple number of rules."; - uses owners-ref; container event { description "This represents the event (e.g., a security event, for which a security rule is made.)"; leaf security-event { type identityref { base security-event-type; } description "This contains the description of security events. If this is not set, it cannot support which security event is enforced"; } - choice enforce-type { + + container time-information { description - "There are two different enforcement types; - admin, and time. - It cannot be allowed to configure - admin=='time' or enforce-time=='admin'."; - case enforce-admin { - leaf admin { - type string; + "The time information when the security + rule should be applied."; + leaf start-date-time { + type yang:date-and-time; description - "This represents the enforcement type - based on admin's decision."; + "This is the start date and time + for policy."; } + leaf end-date-time { + type yang:date-and-time; + description + "This is the end date and time + for policy. The policy will stop + working after the specified + end-date-time"; } - case time { - container time-information { + container period{ + when + "/i2nsf-cfi-policy/rules/rule/event/frequency!='only-once'"; description - "The begin-time and end-time information - when the security rule should be applied."; - leaf enforce-time { - type date-and-time; + "This represents the repetition time. + In case of frequency is weekly, the days + can be set."; + leaf start-time { + type time; description - "The enforcement type is time-enforced."; + "This is period start time for event."; } - leaf begin-time { - type date-and-time; + leaf end-time { + type time; description - "This is start time for time zone"; + "This is period end time for event."; + } + leaf-list day { + when + "/i2nsf-cfi-policy/rules/rule/event/frequency='weekly'"; + type identityref{ + base day; } - leaf end-time { - type date-and-time; description - "This is end time for time zone"; + "This represents the repeated day of + every week (e.g., monday and tuesday). + More than one day can be specified"; } + leaf-list date { + when + "/i2nsf-cfi-policy/rules/rule/event/frequency='monthly'"; + type int32{ + range "1..31"; } + description + "This represents the repeated date of + every month. More than one date can be + specified."; } + leaf-list month { + when + "/i2nsf-cfi-policy/rules/rule/event/frequency='yearly'"; + type string{ + pattern '\d{2}-\d{2}'; + } + description + "This represents the repeated date and month + of every year. More than one can be specified. + Pattern used is Month-Date (MM-DD)."; } + } + } + leaf frequency { type enumeration { enum only-once { description "This represents the rule is enforced - only once immediately and not - repeated."; + only once immediately and not repeated. + The policy will continuously active from + start time and terminated at end-time."; } enum daily { description "This represents the rule is enforced - on a daily basis."; + on a daily basis. The policy will be + repeated daily until the end-date."; } enum weekly { description "This represents the rule is enforced - on a weekly basis."; + on a weekly basis. The policy will be + repeated weekly until the end-date. The + repeated days can be specified."; } enum monthly { description "This represents the rule is enforced - on a monthly basis."; + on a monthly basis. The policy will be + repeated monthly until the end-date."; + + } + enum yearly { + description + "This represents the rule is enforced + on a yearly basis. The policy will be + repeated yearly until the end-date."; } } default only-once; description "This represents how frequent the rule should be enforced."; } } container condition { description "The conditions for general security policies."; container firewall-condition { description "The general firewall condition."; leaf source { type leafref { - path "/i2nsf-cfi-policy/endpoint-groups/user-group/name"; + path + "/i2nsf-cfi-policy/endpoint-groups/user-group/name"; } description "This describes the paths to the source reference."; } - leaf-list dest-target { + + leaf-list destination { type leafref { - path "/i2nsf-cfi-policy/endpoint-groups/user-group/name"; + path + "/i2nsf-cfi-policy/endpoint-groups/user-group/name"; } description "This describes the paths to the destination target reference."; } } + container ddos-condition { description "The condition for DDoS mitigation."; leaf-list source { type leafref { - path "/i2nsf-cfi-policy/endpoint-groups/device-group/name"; + path + "/i2nsf-cfi-policy/endpoint-groups/device-group/name"; } description "This describes the path to the source target references."; } - leaf-list dest-target { + leaf-list destination { type leafref { - path "/i2nsf-cfi-policy/endpoint-groups/device-group/name"; - + path + "/i2nsf-cfi-policy/endpoint-groups/device-group/name"; } description "This describes the path to the destination target references."; } container rate-limit { description "This describes the rate-limit."; leaf packet-threshold-per-second{ type uint32; description "This is a trigger value for the condition."; } } } + + container location-condition { + description + "The condition for location based connection"; + leaf-list source { + type leafref { + path + "/i2nsf-cfi-policy/endpoint-groups/location-group/name"; + } + description + "This describes the path to the location + source reference."; + } + leaf-list destination { + type leafref { + path + "/i2nsf-cfi-policy/endpoint-groups/location-group/name"; + } + description + "This describes the path to the location + destination reference."; + } + } container custom-condition { description "The condition based on packet contents."; leaf-list source { type leafref { - path "/i2nsf-cfi-policy/threat-preventions/payload-content/name"; + path + "/i2nsf-cfi-policy/threat-preventions/payload-content/name"; } description "Describes the payload string content condition source."; } - leaf dest-target { + leaf destination { type leafref { - path "/i2nsf-cfi-policy/threat-preventions/payload-content/name"; + path + "/i2nsf-cfi-policy/threat-preventions/payload-content/name"; } description - "Describes the payload string content condition destination."; + "Describes the payload string content condition + destination."; } } + container threat-feed-condition { description "The condition based on the threat-feed information."; leaf-list source { type leafref { - path "/i2nsf-cfi-policy/threat-preventions/threat-feed-list/name"; + path + "/i2nsf-cfi-policy/threat-preventions/threat-feed-list/name"; } description "Describes the threat-feed condition source."; } - leaf dest-target { + leaf destination { type leafref { - path "/i2nsf-cfi-policy/threat-preventions/threat-feed-list/name"; + path + "/i2nsf-cfi-policy/threat-preventions/threat-feed-list/name"; } - description "Describes the threat-feed condition destination."; } } } container actions { description "This is the action container."; + leaf primary-action { type identityref { base primary-action; } description "This represent the primary actions (e.g., PASS, DROP, ALERT, and MIRROR) to be applied a condition. If this is not set, it cannot support the primary actions."; @@ -1628,38 +1793,42 @@ } container threat-preventions { description "this describes the list of threat-prevention."; list threat-feed-list { key "name"; description "There can be a single or multiple number of threat-feeds."; + leaf name { + type string; + description + "This represents the name of the threat-feed."; + } uses threat-feed-info; leaf-list threat-file-types { type identityref { base malware-file-type; } default executable-file; description "This contains a list of file types needed to be scanned for the virus."; - } leaf-list signatures { type identityref { base signature-type; } default signature-suricata; description - "This contains a list of signatures or hash + "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 payload-content. It should give an idea of why specific payload @@ -1669,104 +1838,112 @@ } description "This represents the payload-string group."; uses payload-string; } } } } - Figure 16: YANG for Consumer-Facing Interface + Figure 17: YANG for Consumer-Facing Interface 9. XML Configuration Examples of High-Level Security Policy Rules - This section shows XML configuration examples of high-level security + Note: This section is informative with XML configuration examples. + + This section is informative with XML configuration examples. This + section shows XML configuration examples of high-level security policy rules that are delivered from the I2NSF User to the Security Controller over the Consumer-Facing Interface. The considered use cases are: Database registration, time-based firewall for web filtering, VoIP/VoLTE security service, and DDoS-attack mitigation. 9.1. Database Registration: Information of Positions and Devices (Endpoint Group) If new endpoints are introduced to the network, it is necessary to first register their data to the database. For example, if new members are newly introduced in either of three different groups (i.e., user-group, device-group, and payload-group), each of them should be registered with information such as ip-addresses or - protocols used by devices. Figure 17 shows an example XML + protocols used by devices. Figure 18 shows an example XML representation of the registered information for the user-group and device-group. - + + employees 221.159.112.1 221.159.112.90 webservers 221.159.112.91 221.159.112.97 http https + - Figure 17: Registering User-group and Device-group Information + Figure 18: Registering User-group and Device-group Information 9.2. Scenario 1: Block SNS Access during Business Hours The first example scenario is to "block SNS access during office hours" using a time-based firewall policy. In this scenario, all users registered as "employees" in the user-group list are unable to - access Social Networking Services (SNS) during the office hours. The - XML instance is described below: + access Social Networking Services (SNS) during the office hours + (weekdays). The XML instance is described below: - security_policy_for_blocking_sns + security_policy_for_blocking_sns123 block_access_to_sns_during_office_hours - 2020-03-11T09:00:00.00Z - 2020-03-11T18:00:00.00Z + 2020-03-11T09:00:00.00Z + 2020-12-31T18:00:00.00Z + + 09:00:00Z + 18:00:00Z + monday + tuesday + wednesday + thursday + friday + - only-once + weekly - + employees - - sns-websites - - + drop - - ipsec-ike - - Figure 18: An XML Example for Time-based Firewall + Figure 19: An XML Example for Time-based Firewall Time-based-condition Firewall 1. The policy name is "security_policy_for_blocking_sns". 2. The rule name is "block_access_to_sns_during_office_hours". 3. The Source is "employees". 4. The destination target is "sns-websites". "sns-websites" is the @@ -1783,53 +1960,56 @@ The second example scenario is to "block malicious VoIP/VoLTE packets coming to a company" using a VoIP policy. In this scenario, the calls comming from from VOIP and/or VOLTE sources with VOLTE IDs that are classified as malicious are dropped. The IP addresses of the employees and malicious VOIP IDs should be blocked are stored in the database or datastore of the enterprise. Here and the rest of the cases assume that the security administrators or someone responsible for the existing and newly generated policies, are not aware of which and/or how many NSFs are needed to meet the security requirements. - Figure 19 represents the XML document generated from YANG discussed + Figure 20 represents the XML document generated from YANG discussed in previous sections. Once a high-level seucurity policy is created by a security admin, it is delivered by the Consumer-Facing Interface, through RESTCONF server, to the security controller. The XML instance is described below: - security_policy_for_blocking_malicious_voip_packets + + security_policy_for_blocking_malicious_voip_packets + Block_malicious_voip_and_volte_packets malicious-id - employees + employees drop ipsec-ikeless - Figure 19: An XML Example for VoIP Security Service + Figure 20: An XML Example for VoIP Security Service Custom-condition Firewall + 1. The policy name is "security_policy_for_blocking_malicious_voip_packets". 2. The rule name is "Block_malicious_voip_and_volte_packets". 3. The Source is "malicious-id". This can be a single ID or a list of IDs, depending on how the ID are stored in the database. The "malicious-id" is the key so that the security admin can read every stored malicious VOIP IDs that are named as "malicious-id". @@ -1860,40 +2040,39 @@ act according to the rule set. The XML instance is described below: security_policy_for_ddos_attacks 100_packets_per_second - webservers + webservers 100 drop ipsec-ikeless - Figure 20: An XML Example for DDoS-attack Mitigation + Figure 21: An XML Example for DDoS-attack Mitigation DDoS-condition Firewall - 1. The policy name is "security_policy_for_ddos_attacks". 2. The rule name is "100_packets_per_second". 3. The destination target is "webservers". "webservers" is the key which represents the list containing information, such as IP addresses and ports, about web-servers. 4. The rate limit exists to limit the incoming amount of packets per second. In this case the rate limit is "100" packets per second. @@ -1901,65 +2080,149 @@ server devices. 5. The Source is all sources which send abnormal amount of packets. 6. The action required is to "drop" packet reception is more than 100 packets per second. 7. The IPsec method used for nsf traffic steering is set to "ipsec- ike". -10. Security Considerations +10. XML Configuration Example of a User Group's Access Control for + I2NSF Consumer-Facing Interface + + Note: This section is informative with an XML configuration example. + + This is an example for creating privileges for a group of users + (i.e., a user group) to access and use the I2NSF Consumer-Facing + Interface to create security policies via the interface. For the + access control of the Consumer-Facing Interface, the NACM module can + be used. Figure 22 shows an XML example the access control of a user + group (named Example-Group) for I2NSF Consumer-Facing Interface A + group called Example-Group can be created and configured with NACM + for the Consumer-Facing Interface. For Example-Group, a rule list + can created with the name of Example-Group-Rules. Example-Group- + Rules has two rules of Example-Group-Rule1 and Example-Group-Rule2 as + follows. For Example-Group-Rule1, the privilege of "Read" is allowed + to Example-Group for the Consumer-Facing Interface. On the other + hand, for Example-Group-Rule2, the privileges of "Create", "Update", + and "Delete" are denied against Example-Group for the Consumer-Facing + Interface. + + + + true + + + Example-Group + Alice + Bob + Eve + + + + Example-Group-Rules + Example-Group + + Example-Group-Rule1 + read + ietf-i2nsf-cfi-policy + permit + + + Example-Group-Rule2 + create update delete + ietf-i2nsf-cfi-policy + deny + + + + + Figure 22: An XML Example of a User Group's Access Control for I2NSF + Consumer-Facing Interface + + The access control for the I2NSF Consumer-Facing Interface is as + follows. + + 1. The NACM is enabled. + + 2. As a group name, Example-Group is specified. + + 3. As members of the group, Alice, Bob, and Eve are specified. + + 4. As a rule list name, Example-Group-Rules is specified for + managing privileges of Example-Group's members. + + 5. As the first rule name, Example-Group-Rule1 is specified. This + rule is used to give read privilege to Example-Group's members + for the module of the I2NSF Consumer-Facing Interface. + + 6. As the second rule name, Example-Group-Rule2 is specified. This + rule is used to deny create, update, and delete privileges + against Example-Group's members for the module of the I2NSF + Consumer-Facing Interface. + +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]. -11. IANA Considerations +12. IANA Considerations This document requests IANA to register the following URI in the "IETF XML Registry" [RFC3688]: URI: urn:ietf:params:xml:ns:yang:ietf-i2nsf-cfi-policy Registrant Contact: The I2NSF. XML: N/A; the requested URI is an XML namespace. This document requests IANA to register the following YANG module in the "YANG Module Names" registry [RFC7950]. name: ietf-i2nsf-cfi-policy namespace: urn:ietf:params:xml:ns:yang:ietf-i2nsf-cfi-policy prefix: cfi-policy reference: RFC 7950 -12. Acknowledgments +13. 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). -13. Contributors +14. Contributors This document is made by the group effort of I2NSF working group. Many people actively contributed to this document, such as Mahdi F. + Dachmehchi and Daeyoung Hyun. The authors sincerely appreciate their contributions. The following are co-authors of this document: + Patrick Lingga + Department of Electronic, Electrical and Computer Engineering + Sungkyunkwan University + 2066 Seo-ro Jangan-gu + Suwon, Gyeonggi-do 16419 + Republic of Korea + + EMail: patricklink@skku.edu + Hyoungshick Kim Department of Computer Science and Engineering Sungkyunkwan University 2066 Seo-ro Jangan-gu Suwon, Gyeonggi-do 16419 Republic of Korea EMail: hyoung@skku.edu Eunsoo Kim @@ -2018,26 +2282,31 @@ 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 +15. References -14.1. Normative References +15.1. Normative References + + [i2nsf-ipsec] + Marin-Lopez, R., Lopez-Millan, G., and F. Pereniguez- + Garcia, "Software-Defined Networking (SDN)-based IPsec + Flow Protection", draft-ietf-i2nsf-sdn-ipsec-flow- + protection-08 (work in progress), June 2020. [RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between Information Models and Data Models", RFC 3444, DOI 10.17487/RFC3444, January 2003, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . @@ -2076,50 +2345,48 @@ [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, . -14.2. Informative References +15.2. Informative References [client-facing-inf-req] Kumar, R., Lohiya, A., Qi, D., Bitar, N., Palislamovic, S., and L. Xia, "Requirements for Client-Facing Interface to Security Controller", draft-ietf-i2nsf-client-facing- interface-req-05 (work in progress), May 2018. [i2nsf-capability-im] Xia, L., Strassner, J., Basile, C., and D. Lopez, "Information Model of NSFs Capabilities", draft-ietf- i2nsf-capability-05 (work in progress), April 2019. - [i2nsf-ipsec] - Marin-Lopez, R., Lopez-Millan, G., and F. Pereniguez- - Garcia, "Software-Defined Networking (SDN)-based IPsec - Flow Protection", draft-ietf-i2nsf-sdn-ipsec-flow- - protection-07 (work in progress), August 2019. - [i2nsf-terminology] Hares, S., Strassner, J., Lopez, D., Xia, L., and H. Birkholz, "Interface to Network Security Functions (I2NSF) Terminology", draft-ietf-i2nsf-terminology-08 (work in progress), July 2019. + [STIX] Jordan, B., Piazza, R., and T. Darley, "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-07 + dm-08 The following changes are made from draft-ietf-i2nsf-consumer-facing- - interface-dm-07: + interface-dm-08: o This version is revised according to the comments from Jan Lindblad who reviewed this document as a YANG doctor. Authors' Addresses Jaehoon Paul Jeong Department of Computer Science and Engineering Sungkyunkwan University 2066 Seobu-Ro, Jangan-Gu