diff options
author | Bozawglanian, Hagop (hb755d) <hb755d@att.com> | 2018-04-16 20:27:57 +0000 |
---|---|---|
committer | Bozawglanian, Hagop (hb755d) <hb755d@att.com> | 2018-04-16 20:39:53 +0000 |
commit | 479cbba5aaad1e58540890e7ac575cf3156f0516 (patch) | |
tree | 47ed2b5564d0c2cffc7b229f39f62ea8f1356fb2 | |
parent | 0a2d0cdba18692e3569a0bb33e440839d206c37f (diff) |
VNFRQTS - Refreshing requirements in Appendix
Updating and Refreshing the requirements in Appendix to fix some bugs/add functionality.
Change-Id: I37c8ca5bcd145469214cc5bb20ee268a30c2d6bf
Issue-ID: VNFRQTS-198
Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
-rw-r--r-- | docs/Chapter8.rst | 2891 |
1 files changed, 1800 insertions, 1091 deletions
diff --git a/docs/Chapter8.rst b/docs/Chapter8.rst index a7456dc..6f35740 100644 --- a/docs/Chapter8.rst +++ b/docs/Chapter8.rst @@ -867,1473 +867,2182 @@ agreed with SDC. The format of the CSAR is specified in SOL004. | | | \\MainServiceTemplate.mf | +------------+-------------------------------------+--------------------------+ - - Requirement List -------------------------------- -R-11200: The VNF **MUST** keep the scope of a Cinder volume module, -when it exists, to be 1:1 with the VNF Base Module or Incremental Module. +**VNF Development Requirements** +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -R-01334: The VNF **MUST** conform to the NETCONF RFC 5717, -“Partial Lock Remote Procedure Call”. +VNF Design +~~~~~~~~~~~~~ -R-51910: The VNF **MUST** provide all telemetry (e.g., fault event -records, syslog records, performance records etc.) to ONAP using the -model, format and mechanisms described in this section. +R-58421 The VNF **SHOULD** be decomposed into granular re-usable VNFCs. -R-29324: The VNF **SHOULD** implement the protocol operation: -**copy-config(target, source) -** Copy the content of the configuration -datastore source to the configuration datastore target. +R-82223 The VNF **MUST** be decomposed if the functions have +significantly different scaling characteristics (e.g., signaling +versus media functions, control versus data plane functions). -R-72184: The VNF **MUST** have routable FQDNs for all the endpoints -(VMs) of a VNF that contain chef-clients which are used to register -with the Chef Server. As part of invoking VNF actions, ONAP will -trigger push jobs against FQDNs of endpoints for a VNF, if required. +R-16496 The VNF **MUST** enable instantiating only the functionality that +is needed for the decomposed VNF (e.g., if transcoding is not needed it +should not be instantiated). -R-23740: The VNF **MUST** accommodate the security principle of -“least privilege” during development, implementation and operation. -The importance of “least privilege” cannot be overstated and must be -observed in all aspects of VNF development and not limited to security. -This is applicable to all sections of this document. +R-02360 The VNFC **MUST** be designed as a standalone, executable process. + +R-34484 The VNF **SHOULD** create a single component VNF for VNFCs +that can be used by other VNFs. + +R-23035 The VNF **MUST** be designed to scale horizontally (more +instances of a VNF or VNFC) and not vertically (moving the existing +instances to larger VMs or increasing the resources within a VM) +to achieve effective utilization of cloud resources. + +R-30650 The VNF **MUST** utilize cloud provided infrastructure and +VNFs (e.g., virtualized Local Load Balancer) as part of the VNF so +that the cloud can manage and provide a consistent service resiliency +and methods across all VNF's. -R-12709: The VNFC **SHOULD** be independently deployed, configured, +R-12709 The VNFC **SHOULD** be independently deployed, configured, upgraded, scaled, monitored, and administered by ONAP. -R-88031: The VNF **SHOULD** implement the protocol operation: -**delete-config(target) -** Delete the named configuration datastore target. +R-37692 The VNFC **MUST** provide API versioning to allow for +independent upgrades of VNFC. -R-42207: The VNF **MUST** design resiliency into a VNF such that the -resiliency deployment model (e.g., active-active) can be chosen at run-time. +R-86585 The VNFC **SHOULD** minimize the use of state within +a VNFC to facilitate the movement of traffic from one instance +to another. -R-98617: The VNF provider **MUST** provide information regarding any -dependency (e.g., affinity, anti-affinity) with other VNFs and resources. +R-65134 The VNF **SHOULD** maintain state in a geographically +redundant datastore that may, in fact, be its own VNFC. -R-62498: The VNF **MUST**, if not using the NCSP’s IDAM API, encrypt -OA&M access (e.g., SSH, SFTP). +R-75850 The VNF **SHOULD** decouple persistent data from the VNFC +and keep it in its own datastore that can be reached by all instances +of the VNFC requiring the data. -R-42366: The VNF **MUST** support secure connections and transports. +R-88199 The VNF **MUST** utilize a persistent datastore service that +can meet the data performance/latency requirements. (For example: +Datastore service could be a VNFC in VNF or a DBaaS in the Cloud +execution environment) -R-33955: The VNF **SHOULD** conform its YANG model to RFC 6991, -“Common YANG Data Types”. +R-99656 The VNF **MUST** NOT terminate stable sessions if a VNFC +instance fails. + +R-84473 The VNF **MUST** enable DPDK in the guest OS for VNF’s requiring +high packets/sec performance. High packet throughput is defined as greater +than 500K packets/sec. -R-33488: The VNF **MUST** protect against all denial of service attacks, -both volumetric and non-volumetric, or integrate with external denial -of service protection tools. +R-54430 The VNF **MUST** use the NCSP’s supported library and compute +flavor that supports DPDK to optimize network efficiency if using DPDK. [5]_ -R-57617: The VNF **MUST** include the field “success/failure” in the -Security alarms (where applicable and technically feasible). +R-18864 The VNF **MUST** NOT use technologies that bypass virtualization +layers (such as SR-IOV) unless approved by the NCSP (e.g., if necessary +to meet functional or performance requirements). -R-57271: The VNF **MUST** provide the capability of generating security -audit logs by interacting with the operating system (OS) as appropriate. +R-64768 The VNF **MUST** limit the size of application data packets +to no larger than 9000 bytes for SDN network-based tunneling when +guest data packets are transported between tunnel endpoints that +support guest logical networks. + +R-74481 The VNF **MUST** NOT require the use of a dynamic routing +protocol unless necessary to meet functional requirements. + +VNF Resiliency +~~~~~~~~~~~~~~~~~~~~~~~~~ + +R-52499 The VNF **MUST** meet their own resiliency goals and not rely +on the Network Cloud. + +R-42207 The VNF **MUST** design resiliency into a VNF such that the +resiliency deployment model (e.g., active-active) can be chosen at +run-time. + +R-03954 The VNF **MUST** survive any single points of failure within +the Network Cloud (e.g., virtual NIC, VM, disk failure). + +R-89010 The VNF **MUST** survive any single points of software failure +internal to the VNF (e.g., in memory structures, JMS message queues). + +R-67709 The VNF **MUST** be designed, built and packaged to enable +deployment across multiple fault zones (e.g., VNFCs deployed in +different servers, racks, OpenStack regions, geographies) so that +in the event of a planned/unplanned downtime of a fault zone, the +overall operation/throughput of the VNF is maintained. + +R-35291 The VNF **MUST** support the ability to failover a VNFC +automatically to other geographically redundant sites if not +deployed active-active to increase the overall resiliency of the VNF. + +R-36843 The VNF **MUST** support the ability of the VNFC to be deployable +in multi-zoned cloud sites to allow for site support in the event of cloud +zone failure or upgrades. + +R-92935 The VNF **SHOULD** minimize the propagation of state information +across multiple data centers to avoid cross data center traffic. + +R-26371 The VNF **MUST** detect communication failure for inter VNFC +instance and intra/inter VNF and re-establish communication +automatically to maintain the VNF without manual intervention to +provide service continuity. + +R-18725 The VNF **MUST** handle the restart of a single VNFC instance +without requiring all VNFC instances to be restarted. + +R-06668 The VNF **MUST** handle the start or restart of VNFC instances +in any order with each VNFC instance establishing or re-establishing +required connections or relationships with other VNFC instances and/or +VNFs required to perform the VNF function/role without requiring VNFC +instance(s) to be started/restarted in a particular order. -R-44569: The VNF provider **MUST NOT** require additional infrastructure -such as a VNF provider license server for VNF providor functions and metrics. +R-80070 The VNF **MUST** handle errors and exceptions so that they do +not interrupt processing of incoming VNF requests to maintain service +continuity (where the error is not directly impacting the software +handling the incoming request). -R-67918: The VNF **MUST** handle replication race conditions both locally +R-32695 The VNF **MUST** provide the ability to modify the number of +retries, the time between retries and the behavior/action taken after +the retries have been exhausted for exception handling to allow the +NCSP to control that behavior, where the interface and/or functional +specification allows for altering behaviour. + +R-48356 The VNF **MUST** fully exploit exception handling to the extent +that resources (e.g., threads and memory) are released when no longer +needed regardless of programming language. + +R-67918 The VNF **MUST** handle replication race conditions both locally and geo-located in the event of a data base instance failure to maintain service continuity. -R-35532: The VNF **SHOULD** release and clear all shared assets (memory, +R-36792 The VNF **MUST** automatically retry/resubmit failed requests +made by the software to its downstream system to increase the success rate. + +R-22059 The VNF **MUST NOT** execute long running tasks (e.g., IO, +database, network operations, service calls) in a critical section +of code, so as to minimize blocking of other operations and increase +concurrent throughput. + +R-63473 The VNF **MUST** automatically advertise newly scaled +components so there is no manual intervention required. + +R-74712 The VNF **MUST** utilize FQDNs (and not IP address) for +both Service Chaining and scaling. + +R-41159 The VNF **MUST** deliver any and all functionality from any +VNFC in the pool (where pooling is the most suitable solution). The +VNFC pool member should be transparent to the client. Upstream and +downstream clients should only recognize the function being performed, +not the member performing it. + +R-85959 The VNF **SHOULD** automatically enable/disable added/removed +sub-components or component so there is no manual intervention required. + +R-06885 The VNF **SHOULD** support the ability to scale down a VNFC pool +without jeopardizing active sessions. Ideally, an active session should +not be tied to any particular VNFC instance. + +R-12538 The VNF **SHOULD** support load balancing and discovery +mechanisms in resource pools containing VNFC instances. + +R-98989 The VNF **SHOULD** utilize resource pooling (threads, +connections, etc.) within the VNF application so that resources +are not being created and destroyed resulting in resource management +overhead. + +R-55345 The VNF **SHOULD** use techniques such as “lazy loading” when +initialization includes loading catalogues and/or lists which can grow +over time, so that the VNF startup time does not grow at a rate +proportional to that of the list. + +R-35532 The VNF **SHOULD** release and clear all shared assets (memory, database operations, connections, locks, etc.) as soon as possible, especially before long running sync and asynchronous operations, so as to not prevent use of these assets by other entities. -R-37692: The VNFC **MUST** provide API versioning to allow for -independent upgrades of VNFC. +R-77334 The VNF **MUST** allow configurations and configuration parameters +to be managed under version control to ensure consistent configuration +deployment, traceability and rollback. -R-50252: The VNF **MUST** write to a specific set of text files that -will be retrieved and made available by the Ansible Server If, as part -of a VNF action (e.g., audit), a playbook is required to return any VNF -information. +R-99766 The VNF **MUST** allow configurations and configuration parameters +to be managed under version control to ensure the ability to rollback to +a known valid configuration. -R-58977: The VNF **MUST** provide or support the Identity and Access -Management (IDAM) based threat detection data for Eavesdropping. +R-73583 The VNF **MUST** allow changes of configuration parameters +to be consumed by the VNF without requiring the VNF or its sub-components +to be bounced so that the VNF availability is not effected. -R-59391: The VNF provider **MUST**, where a VNF provider requires the -assumption of permissions, such as root or administrator, first log in -under their individual user login ID then switch to the other higher -level account; or where the individual user login is infeasible, must -login with an account with admin privileges in a way that uniquely -identifies the individual performing the function. +R-21558 The VNF **SHOULD** use intelligent routing by having knowledge +of multiple downstream/upstream endpoints that are exposed to it, to +ensure there is no dependency on external services (such as load balancers) +to switch to alternate endpoints. -R-93443: The VNF **MUST** define all data models in YANG [RFC6020], -and the mapping to NETCONF shall follow the rules defined in this RFC. +R-08315 The VNF **SHOULD** use redundant connection pooling to connect +to any backend data source that can be switched between pools in an +automated/scripted fashion to ensure high availability of the connection +to the data source. -R-72243: The VNF **MUST** provide or support the Identity and Access -Management (IDAM) based threat detection data for Phishing / SMishing. +R-27995 The VNF **SHOULD** include control loop mechanisms to notify +the consumer of the VNF of their exceeding SLA thresholds so the consumer +is able to control its load against the VNF. -R-33280: The VNF **MUST NOT** use any instance specific parameters in -a playbook. - -R-73468: The VNF **MUST** allow the NETCONF server connection parameters -to be configurable during virtual machine instantiation through Heat -templates where SSH keys, usernames, passwords, SSH service and SSH port -numbers are Heat template parameters. - -R-46908: The VNF **MUST**, if not using the NCSP’s IDAM API, comply with -"password complexity" policy. When passwords are used, they shall be complex -and shall at least meet the following password construction requirements: -(1) be a minimum configurable number of characters in length, (2) include -3 of the 4 following types of characters: upper-case alphabetic, lower-case -alphabetic, numeric, and special, (3) not be the same as the UserID with -which they are associated or other common strings as specified by the -environment, (4) not contain repeating or sequential characters or numbers, -(5) not to use special characters that may have command functions, and (6) -new passwords must not contain sequences of three or more characters from -the previous password. - -R-86261: The VNF **MUST NOT** allow VNF provider access to VNFs remotely. - -R-75343: The VNF **MUST** provide the capability of testing the validity -of a digital certificate by recognizing the identity represented by the -certificate — the "distinguished name". - -R-40813: The VNF **SHOULD** support the use of virtual trusted platform -module, hypervisor security testing and standards scanning tools. +R-73364 The VNF **MUST** support at least two major versions of the +VNF software and/or sub-components to co-exist within production +environments at any time so that upgrades can be applied across +multiple systems in a staggered manner. -R-02454: The VNF **MUST** support the existence of multiple major/minor +R-02454 The VNF **MUST** support the existence of multiple major/minor versions of the VNF software and/or sub-components and interfaces that -support both forward and backward compatibility to be transparent to the -Service Provider usage. +support both forward and backward compatibility to be transparent to +the Service Provider usage. -R-20353: The VNF **MUST** implement at least one of the capabilities -**:candidate** or **:writable-running**. If both **:candidate** and -**:writable-running** are provided then two locks should be supported. +R-57855 The VNF **MUST** support hitless staggered/rolling deployments +between its redundant instances to allow "soak-time/burn in/slow roll" +which can enable the support of low traffic loads to validate the +deployment prior to supporting full traffic loads. -R-01556: The VNF Package **MUST** include documentation describing -the fault, performance, capacity events/alarms and other event records -that are made available by the VNF. The document must include: +R-64445 The VNF **MUST** support the ability of a requestor of the +service to determine the version (and therefore capabilities) of the +service so that Network Cloud Service Provider can understand the +capabilities of the service. -R-56815: The VNF Package **MUST** include documentation describing -supported VNF scaling capabilities and capacity limits (e.g., number -of users, bandwidth, throughput, concurrent calls). +R-56793 The VNF **MUST** test for adherence to the defined performance +budgets at each layer, during each delivery cycle with delivered +results, so that the performance budget is measured and the code +is adjusted to meet performance budget. -R-56793: The VNF **MUST** test for adherence to the defined performance -budgets at each layer, during each delivery cycle with delivered results, -so that the performance budget is measured and the code is adjusted to -meet performance budget. +R-77667 The VNF **MUST** test for adherence to the defined performance +budget at each layer, during each delivery cycle so that the performance +budget is measured and feedback is provided where the performance budget +is not met. -R-54520: The VNF **MUST** log successful and unsuccessful login attempts. +R-49308 The VNF **SHOULD** test for adherence to the defined resiliency +rating recommendation at each layer, during each delivery cycle with +delivered results, so that the resiliency rating is measured and the +code is adjusted to meet software resiliency requirements. -R-10173: The VNF **MUST** allow another NETCONF session to be able to -initiate the release of the lock by killing the session owning the lock, -using the <kill-session> operation to guard against hung NETCONF sessions. +R-16039 The VNF **SHOULD** test for adherence to the defined +resiliency rating recommendation at each layer, during each +delivery cycle so that the resiliency rating is measured and +feedback is provided where software resiliency requirements are +not met. -R-36280: The VNF provider **MUST** provide documentation describing VNF -Functional Capabilities that are utilized to operationalize the VNF and -compose complex services. +R-34957 The VNF **MUST** provide a method of metrics gathering for each +layer's performance to identify/document variances in the allocations so +they can be addressed. -R-15671: The VNF **MUST NOT** provide public or unrestricted access to any -data without the permission of the data owner. All data classification and -access controls must be followed. +R-49224 The VNF **MUST** provide unique traceability of a transaction +through its life cycle to ensure quick and efficient troubleshooting. -R-39342: The VNF **MUST**, if not using the NCSP’s IDAM API, comply with -"password changes (includes default passwords)" policy. Products -will support password aging, syntax and other credential management -practices on a configurable basis. +R-52870 The VNF **MUST** provide a method of metrics gathering +and analysis to evaluate the resiliency of the software from both +a granular as well as a holistic standpoint. This includes, but is +not limited to thread utilization, errors, timeouts, and retries. -R-21558: The VNF **SHOULD** use intelligent routing by having knowledge -of multiple downstream/upstream endpoints that are exposed to it, to ensure -there is no dependency on external services (such as load balancers) to -switch to alternate endpoints. +R-92571 The VNF **MUST** provide operational instrumentation such as +logging, so as to facilitate quick resolution of issues with the VNF to +provide service continuity. -R-07545: The VNF **MUST** support all operations, administration and -management (OAM) functions available from the supplier for VNFs using -the supplied YANG code and associated NETCONF servers. +R-48917 The VNF **MUST** monitor for and alert on (both sender and +receiver) errant, running longer than expected and missing file transfers, +so as to minimize the impact due to file transfer errors. -R-73541: The VNF **MUST** use access controls for VNFs and their -supporting computing systems at all times to restrict access to -authorized personnel only, e.g., least privilege. These controls -could include the use of system configuration or access control software. +R-28168 The VNF **SHOULD** use an appropriately configured logging +level that can be changed dynamically, so as to not cause performance +degradation of the VNF due to excessive logging. -R-97102: The VNF Package **MUST** include VM requirements via a Heat -template that provides the necessary data for: +R-87352 The VNF **SHOULD** utilize Cloud health checks, when available +from the Network Cloud, from inside the application through APIs to check +the network connectivity, dropped packets rate, injection, and auto failover +to alternate sites if needed. -R-44013: The VNF **MUST** populate an attribute, defined as -node[‘PushJobOutput’] with the desired output on all nodes in the push -job that execute chef-client run if the VNF action requires the output -of a chef-client run be made available (e.g., get running configuration). +R-16560 The VNF **SHOULD** conduct a resiliency impact assessment for all +inter/intra-connectivity points in the VNF to provide an overall resiliency +rating for the VNF to be incorporated into the software design and +development of the VNF. -R-40521: The VNF **MUST**, if not using the NCSP’s IDAM API, support use of -common third party authentication and authorization tools such as TACACS+, -RADIUS. +VNF Security +~~~~~~~~~~~~~~ -R-41829: The VNF **MUST** be able to specify the granularity of the lock -via a restricted or full XPath expression. +R-23740 The VNF **MUST** accommodate the security principle of +“least privilege” during development, implementation and operation. +The importance of “least privilege” cannot be overstated and must be +observed in all aspects of VNF development and not limited to security. +This is applicable to all sections of this document. -R-19768: The VNF **SHOULD** support L3 VPNs that enable segregation of +R-61354 The VNF **MUST** implement access control list for OA&M +services (e.g., restricting access to certain ports or applications). + +R-85633 The VNF **MUST** implement Data Storage Encryption +(database/disk encryption) for Sensitive Personal Information (SPI) +and other subscriber identifiable data. Note: subscriber’s SPI/data +must be encrypted at rest, and other subscriber identifiable data +should be encrypted at rest. Other data protection requirements exist +and should be well understood by the developer. + +R-92207 The VNF **SHOULD** implement a mechanism for automated and +frequent "system configuration (automated provisioning / closed loop)" +auditing. + +R-23882 The VNF **SHOULD** be scanned using both network scanning +and application scanning security tools on all code, including underlying +OS and related configuration. Scan reports shall be provided. Remediation +roadmaps shall be made available for any findings. + +R-46986 The VNF **SHOULD** have source code scanned using scanning +tools (e.g., Fortify) and provide reports. + +R-55830 The VNF **MUST** distribute all production code from NCSP +internal sources only. No production code, libraries, OS images, etc. +shall be distributed from publically accessible depots. + +R-99771 The VNF **MUST** provide all code/configuration files in a +"Locked down" or hardened state or with documented recommendations for +such hardening. All unnecessary services will be disabled. VNF provider +default credentials, community strings and other such artifacts will be +removed or disclosed so that they can be modified or removed during +provisioning. + +R-19768 The VNF **SHOULD** support L3 VPNs that enable segregation of traffic by application (dropping packets not belonging to the VPN) (i.e., AVPN, IPSec VPN for Internet routes). -R-55478: The VNF **MUST** log logoffs. +R-33981 The VNF **SHOULD** interoperate with various access control +mechanisms for the Network Cloud execution environment (e.g., +Hypervisors, containers). -R-14853: The VNF **MUST** respond to a "move traffic" [2]_ command against a -specific VNFC, moving all existing session elsewhere with minimal disruption -if a VNF provides a load balancing function across multiple instances of its -VNFCs. Note: Individual VNF performance aspects (e.g., move duration or -disruption scope) may require further constraints. +R-40813 The VNF **SHOULD** support the use of virtual trusted platform +module, hypervisor security testing and standards scanning tools. -R-68165: The VNF **MUST** encrypt any content containing Sensitive Personal -Information (SPI) or certain proprietary data, in addition to applying the -regular procedures for securing access and delivery. +R-56904 The VNF **MUST** interoperate with the ONAP (SDN) Controller so that +it can dynamically modify the firewall rules, ACL rules, QoS rules, virtual +routing and forwarding rules. -R-31614: The VNF **MUST** log the field “event type” in the security audit -logs. +R-26586 The VNF **SHOULD** support the ability to work with aliases +(e.g., gateways, proxies) to protect and encapsulate resources. -R-87662: The VNF **SHOULD** implement the NETCONF Event Notifications -[RFC5277]. +R-49956 The VNF **MUST** pass all access to applications (Bearer, +signaling and OA&M) through various security tools and platforms from +ACLs, stateful firewalls and application layer gateways depending on +manner of deployment. The application is expected to function (and in +some cases, interwork) with these security tools. -R-26508: The VNF **MUST** support NETCONF server that can be mounted -on OpenDaylight (client) and perform the following operations: +R-69649 The VNF **MUST** have all vulnerabilities patched as soon +as possible. Patching shall be controlled via change control process +with vulnerabilities disclosed along with mitigation recommendations. -R-26567: The VNF Package **MUST** include a run list of -roles/cookbooks/recipes, for each supported VNF action, that will perform -the desired VNF action in its entirety as specified by ONAP (see Section -8.c, ONAP Controller APIs and Behavior, for list of VNF actions and -requirements), when triggered by a chef-client run list in JSON file. +R-78010 The VNF **MUST** use the NCSP’s IDAM API for Identification, +authentication and access control of customer or VNF application users. -R-04158: The VNF **MUST** conform to the NETCONF RFC 4742, -“Using the NETCONF Configuration Protocol over Secure Shell (SSH)”. +R-42681 The VNF **MUST** use the NCSP’s IDAM API or comply with +the requirements if not using the NCSP’s IDAM API, for identification, +authentication and access control of OA&M and other system level +functions. -R-49109: The VNF **MUST** encrypt TCP/IP--HTTPS (e.g., TLS v1.2) transmission -of data on internal and external networks. +R-68589 The VNF **MUST**, if not using the NCSP’s IDAM API, support +User-IDs and passwords to uniquely identify the user/application. VNF +needs to have appropriate connectors to the Identity, Authentication +and Authorization systems that enables access at OS, Database and +Application levels as appropriate. -R-15884: The VNF **MUST** include the field “date” in the Security alarms -(where applicable and technically feasible). +R-52085 The VNF **MUST**, if not using the NCSP’s IDAM API, provide +the ability to support Multi-Factor Authentication (e.g., 1st factor = +Software token on device (RSA SecureID); 2nd factor = User Name+Password, +etc.) for the users. -R-15885: The VNF **MUST** Upon completion of the chef-client run, POST -back on the callback URL, a JSON object as described in Table A2 if the -chef-client run list includes a cookbook/recipe that is callback capable. -Failure to POST on the Callback Url should not be considered a critical -error. That is, if the chef-client successfully completes the VNF action, -it should reflect this status on the Chef Server regardless of whether -the Callback succeeded or not. +R-98391 The VNF **MUST**, if not using the NCSP’s IDAM API, support +Role-Based Access Control to permit/limit the user/application to +performing specific activities. -R-82223: The VNF **MUST** be decomposed if the functions have significantly -different scaling characteristics (e.g., signaling versus media functions, -control versus data plane functions). +R-63217 The VNF **MUST**, if not using the NCSP’s IDAM API, support +logging via ONAP for a historical view of “who did what and when”. -R-37608: The VNF **MUST** provide a mechanism to restrict access based -on the attributes of the VNF and the attributes of the subject. +R-62498 The VNF **MUST**, if not using the NCSP’s IDAM API, encrypt +OA&M access (e.g., SSH, SFTP). -R-02170: The VNF **MUST** use, whenever possible, standard implementations -of security applications, protocols, and format, e.g., S/MIME, TLS, SSH, -IPSec, X.509 digital certificates for cryptographic implementations. -These implementations must be purchased from reputable vendors and must -not be developed in-house. +R-79107 The VNF **MUST**, if not using the NCSP’s IDAM API, enforce +a configurable maximum number of Login attempts policy for the users. +VNF provider must comply with "terminate idle sessions" policy. +Interactive sessions must be terminated, or a secure, locking screensaver +must be activated requiring authentication, after a configurable period +of inactivity. The system-based inactivity timeout for the enterprise +identity and access management system must also be configurable. + +R-35144 The VNF **MUST**, if not using the NCSP’s IDAM API, comply +with the NCSP’s credential management policy. + +R-75041 The VNF **MUST**, if not using the NCSP’s IDAM API, expire +passwords at regular configurable intervals. + +R-46908 The VNF **MUST**, if not using the NCSP’s IDAM API, comply +with "password complexity" policy. When passwords are used, they shall +be complex and shall at least meet the following password construction +requirements: (1) be a minimum configurable number of characters in +length, (2) include 3 of the 4 following types of characters: +upper-case alphabetic, lower-case alphabetic, numeric, and special, +(3) not be the same as the UserID with which they are associated or +other common strings as specified by the environment, (4) not contain +repeating or sequential characters or numbers, (5) not to use special +characters that may have command functions, and (6) new passwords must +not contain sequences of three or more characters from the previous +password. + +R-39342 The VNF **MUST**, if not using the NCSP’s IDAM API, comply +with "password changes (includes default passwords)" policy. Products +will support password aging, syntax and other credential management +practices on a configurable basis. -R-11235: The VNF **MUST** implement the protocol operation: -**kill-session(session)** - Force the termination of **session**. +R-40521 The VNF **MUST**, if not using the NCSP’s IDAM API, support +use of common third party authentication and authorization tools such +as TACACS+, RADIUS. -R-87564: The VNF **SHOULD** conform its YANG model to RFC 7317, -“A YANG Data Model for System Management”. +R-41994 The VNF **MUST**, if not using the NCSP’s IDAM API, comply +with "No Self-Signed Certificates" policy. Self-signed certificates +must be used for encryption only, using specified and approved +encryption protocols such as TLS 1.2 or higher or equivalent security +protocols such as IPSec, AES. -R-69649: The VNF **MUST** have all vulnerabilities patched as soon as -possible. Patching shall be controlled via change control process with -vulnerabilities disclosed along with mitigation recommendations. +R-23135 The VNF **MUST**, if not using the NCSP’s IDAM API, +authenticate system to system communications where one system +accesses the resources of another system, and must never conceal +individual accountability. -R-75041: The VNF **MUST**, if not using the NCSP’s IDAM API, expire passwords -at regular configurable intervals. +R-95105 The VNF **MUST** host connectors for access to the application +layer. -R-23035: The VNF **MUST** be designed to scale horizontally (more instances -of a VNF or VNFC) and not vertically (moving the existing instances to larger -VMs or increasing the resources within a VM) to achieve effective utilization -of cloud resources. +R-45496 The VNF **MUST** host connectors for access to the OS +(Operating System) layer. -R-97445: The VNF **MUST** log the field “date/time” in the security audit logs. +R-05470 The VNF **MUST** host connectors for access to the database layer. -R-16777: The VNF provider **MUST** provide a JSON file for each supported -action for the VNF. The JSON file must contain key value pairs with all -relevant values populated with sample data that illustrates its usage. -The fields and their description are defined in Appendix B. +R-99174 The VNF **MUST** comply with Individual Accountability +(each person must be assigned a unique ID) when persons or non-person +entities access VNFs. -R-08134: The VNF **MUST** conform to the NETCONF RFC 6241, -“NETCONF Configuration Protocol”. +R-42874 The VNF **MUST** comply with Least Privilege (no more +privilege than required to perform job functions) when persons +or non-person entities access VNFs. -R-01382: The VNF **MUST** allow the entire configuration of the VNF to -be retrieved via NETCONF's <get-config> and <edit-config>, independently -of whether it was configured via NETCONF or other mechanisms. +R-71787 The VNF **MUST** comply with Segregation of Duties (access to a +single layer and no developer may access production without special +oversight) when persons or non-person entities access VNFs. -R-48356: The VNF **MUST** fully exploit exception handling to the extent -that resources (e.g., threads and memory) are released when no longer -needed regardless of programming language. +R-86261 The VNF **MUST NOT** allow VNF provider access to VNFs remotely. -R-90007: The VNF **MUST** implement the protocol operation: -**close-session()**- Gracefully close the current session. +R-49945 The VNF **MUST** authorize VNF provider access through a +client application API by the client application owner and the resource +owner of the VNF before provisioning authorization through Role Based +Access Control (RBAC), Attribute Based Access Control (ABAC), or other +policy based mechanism. -R-42140: The VNF **MUST** respond to data requests from ONAP as soon as -those requests are received, as a synchronous response. +R-31751 The VNF **MUST** subject VNF provider access to privilege +reconciliation tools to prevent access creep and ensure correct +enforcement of access policies. -R-27511: The VNF provider **MUST** provide the ability to scale up a VNF -provider supplied product during growth and scale down a VNF provider -supplied product during decline without “real-time” restrictions based -upon VNF provider permissions. +R-34552 The VNF **MUST** provide or support the Identity and Access +Management (IDAM) based threat detection data for OWASP Top 10. + +R-29301 The VNF **MUST** provide or support the Identity and Access +Management (IDAM) based threat detection data for Password Attacks. -R-05470: The VNF **MUST** host connectors for access to the database layer. +R-72243 The VNF **MUST** provide or support the Identity and Access +Management (IDAM) based threat detection data for Phishing / SMishing. -R-85633: The VNF **MUST** implement Data Storage Encryption (database/disk -encryption) for Sensitive Personal Information (SPI) and other subscriber -identifiable data. Note: subscriber’s SPI/data must be encrypted at rest, -and other subscriber identifiable data should be encrypted at rest. Other -data protection requirements exist and should be well understood by the -developer. +R-58998 The VNF **MUST** provide or support the Identity and Access +Management (IDAM) based threat detection data for Malware (Key Logger). -R-36792: The VNF **MUST** automatically retry/resubmit failed requests -made by the software to its downstream system to increase the success rate. +R-14025 The VNF **MUST** provide or support the Identity and Access +Management (IDAM) based threat detection data for Session Hijacking. -R-49036: The VNF **SHOULD** conform its YANG model to RFC 7277, -“A YANG Data Model for IP Management”. +R-31412 The VNF **MUST** provide or support the Identity and Access +Management (IDAM) based threat detection data for XSS / CSRF. -R-63217: The VNF **MUST**, if not using the NCSP’s IDAM API, support -logging via ONAP for a historical view of “who did what and when”. +R-51883 The VNF **MUST** provide or support the Identity and Access +Management (IDAM) based threat detection data for Replay. -R-44125: The VNF provider **MUST** agree to the process that can be met -by Service Provider reporting infrastructure. The Contract shall define -the reporting process and the available reporting tools. +R-44032 The VNF **MUST** provide or support the Identity and Access +Management (IDAM) based threat detection data for Man in the Middle (MITM). -R-22700: The VNF **MUST** conform its YANG model to RFC 6470, -“NETCONF Base Notifications”. +R-58977 The VNF **MUST** provide or support the Identity and Access +Management (IDAM) based threat detection data for Eavesdropping. -R-74958: The VNF **MUST** activate security alarms automatically when -the following event is detected: unsuccessful attempts to gain permissions -or assume the identity of another user +R-24825 The VNF **MUST** provide Context awareness data (device, +location, time, etc.) and be able to integrate with threat detection system. -R-44281: The VNF **MUST** implement the protocol operation: -**edit-config(target, default-operation, test-option, error-option, -config)** - Edit the target configuration datastore by merging, -replacing, creating, or deleting new config elements. +R-59391 The VNF provider **MUST**, where a VNF provider requires +the assumption of permissions, such as root or administrator, first +log in under their individual user login ID then switch to the other +higher level account; or where the individual user login is infeasible, +must login with an account with admin privileges in a way that +uniquely identifies the individual performing the function. -R-81777: The VNF **MUST** be configured with initial address(es) to -use at deployment time. After that the address(es) may be changed -through ONAP-defined policies delivered from ONAP to the VNF using -PUTs to a RESTful API, in the same way that other controls over data -reporting will be controlled by policy. +R-85028 The VNF **MUST** authenticate system to system access and +do not conceal a VNF provider user’s individual accountability for +transactions. -R-57855: The VNF **MUST** support hitless staggered/rolling deployments -between its redundant instances to allow "soak-time/burn in/slow roll" -which can enable the support of low traffic loads to validate the -deployment prior to supporting full traffic loads. +R-80335 The VNF **MUST** make visible a Warning Notice: A formal +statement of resource intent, i.e., a warning notice, upon initial +access to a VNF provider user who accesses private internal networks +or Company computer resources, e.g., upon initial logon to an internal +web site, system or application which requires authentication. -R-73285: The VNF **MUST** must encode the delivered data using JSON or Avro, -addressed and delivered as described in the previous paragraphs. +R-73541 The VNF **MUST** use access controls for VNFs and their +supporting computing systems at all times to restrict access to +authorized personnel only, e.g., least privilege. These controls +could include the use of system configuration or access control +software. -R-85028: The VNF **MUST** authenticate system to system access and do not -conceal a VNF provider user’s individual accountability for transactions. +R-64503 The VNF **MUST** provide minimum privileges for initial +and default settings for new user accounts. -R-28545: The VNF **MUST** conform its YANG model to RFC 6060, “YANG - A -Data Modeling Language for the Network Configuration Protocol (NETCONF)” +R-86835 The VNF **MUST** set the default settings for user access +to sensitive commands and data to deny authorization. -R-74712: The VNF **MUST** utilize FQDNs (and not IP address) for both -Service Chaining and scaling. +R-77157 The VNF **MUST** conform to approved request, workflow +authorization, and authorization provisioning requirements when +creating privileged users. -R-29760: The VNFC **MUST** be installed on non-root file systems, unless -software is specifically included with the operating system distribution -of the guest image. +R-81147 The VNF **MUST** have greater restrictions for access and +execution, such as up to 3 factors of authentication and restricted +authorization, for commands affecting network services, such as +commands relating to VNFs. -R-08315: The VNF **SHOULD** use redundant connection pooling to connect -to any backend data source that can be switched between pools in an -automated/scripted fashion to ensure high availability of the connection -to the data source. +R-49109 The VNF **MUST** encrypt TCP/IP--HTTPS (e.g., TLS v1.2) +transmission of data on internal and external networks. -R-42874: The VNF **MUST** comply with Least Privilege (no more privilege -than required to perform job functions) when persons or non-person entities -access VNFs. +R-39562 The VNF **MUST** disable unnecessary or vulnerable cgi-bin programs. -R-08312: The VNF **MAY** use other options which are expected to include +R-15671 The VNF **MUST NOT** provide public or unrestricted access +to any data without the permission of the data owner. All data +classification and access controls must be followed. -R-19082: The VNF **MUST NOT** run security testing tools and programs, e.g., -password cracker, port scanners, hacking tools in production, without +R-89753 The VNF **MUST NOT** install or use systems, tools or +utilities capable of capturing or logging data that was not created +by them or sent specifically to them in production, without authorization of the VNF system owner. -R-39650: The VNF **SHOULD** provide the ability to test incremental growth -of the VNF. +R-19082 The VNF **MUST NOT** run security testing tools and +programs, e.g., password cracker, port scanners, hacking tools +in production, without authorization of the VNF system owner. -R-15325: The VNF **MUST** log the field “success/failure” in the security -audit logs. +R-19790 The VNF **MUST NOT** include authentication credentials +in security audit logs, even if encrypted. -R-07617: The VNF **MUST** log creating, removing, or changing the inherent -privilege level of users. +R-85419 The VNF **SHOULD** use REST APIs exposed to Client +Applications for the implementation of OAuth 2.0 Authorization +Code Grant and Client Credentials Grant, as the standard interface +for a VNF. -R-53015: The VNF **MUST** apply locking based on the sequence of NETCONF -operations, with the first configuration operation locking out all others -until completed. +R-86455 The VNF **SHOULD** support hosting connectors for OS +Level and Application Access. -R-83500: The VNF **MUST** provide the capability of allowing certificate -renewal and revocation. +R-48080 The VNF **SHOULD** support SCEP (Simple Certificate +Enrollment Protocol). -R-23772: The VNF **MUST** validate input at all layers implementing VNF APIs. +R-37608 The VNF **MUST** provide a mechanism to restrict access based +on the attributes of the VNF and the attributes of the subject. -R-83227: The VNF **MUST** Provide the capability to encrypt data in transit -on a physical or virtual network. +R-43884 The VNF **MUST** integrate with external authentication +and authorization services (e.g., IDAM). -R-36843: The VNF **MUST** support the ability of the VNFC to be deployable -in multi-zoned cloud sites to allow for site support in the event of cloud -zone failure or upgrades. +R-25878 The VNF **MUST** use certificates issued from publicly +recognized Certificate Authorities (CA) for the authentication process +where PKI-based authentication is used. -R-10129: The VNF **SHOULD** conform its YANG model to RFC 7223, -“A YANG Data Model for Interface Management”. +R-19804 The VNF **MUST** validate the CA signature on the certificate, +ensure that the date is within the validity period of the certificate, +check the Certificate Revocation List (CRL), and recognize the identity +represented by the certificate where PKI-based authentication is used. + +R-47204 The VNF **MUST** protect the confidentiality and integrity of +data at rest and in transit from unauthorized access and modification. + +R-33488 The VNF **MUST** protect against all denial of service +attacks, both volumetric and non-volumetric, or integrate with external +denial of service protection tools. + +R-21652 The VNF **MUST** implement the following input validation +control: Check the size (length) of all input. Do not permit an amount +of input so great that it would cause the VNF to fail. Where the input +may be a file, the VNF API must enforce a size limit. + +R-54930 The VNF **MUST** implement the following input validation +control: Do not permit input that contains content or characters +inappropriate to the input expected by the design. Inappropriate input, +such as SQL insertions, may cause the system to execute undesirable +and unauthorized transactions against the database or allow other +inappropriate access to the internal network. + +R-21210 The VNF **MUST** implement the following input validation +control: Validate that any input file has a correct and valid +Multipurpose Internet Mail Extensions (MIME) type. Input files +should be tested for spoofed MIME types. + +R-23772 The VNF **MUST** validate input at all layers implementing VNF APIs. + +R-87135 The VNF **MUST** comply with NIST standards and industry +best practices for all implementations of cryptography. + +R-02137 The VNF **MUST** implement all monitoring and logging as +described in the Security Analytics section. -R-18733: The VNF **MUST** implement the protocol operation: -**discard-changes()** - Revert the candidate configuration datastore to -the running configuration. +R-15659 The VNF **MUST** restrict changing the criticality level of +a system security alarm to administrator(s). -R-21819: The VNF **MUST** support requests for information from law +R-19367 The VNF **MUST** monitor API invocation patterns to detect +anomalous access patterns that may represent fraudulent access or +other types of attacks, or integrate with tools that implement anomaly +and abuse detection. + +R-78066 The VNF **MUST** support requests for information from law enforcement and government agencies. -R-92207: The VNF **SHOULD** implement a mechanism for automated and frequent -"system configuration (automated provisioning / closed loop)" auditing. +R-48470 The VNF **MUST** support Real-time detection and +notification of security events. -R-63935: The VNF **MUST** release locks to prevent permanent lock-outs when -a user configured timer has expired forcing the NETCONF SSH Session -termination (i.e., product must expose a configuration knob for a user -setting of a lock expiration timer) +R-22286 The VNF **MUST** support Integration functionality via +API/Syslog/SNMP to other functional modules in the network (e.g., +PCRF, PCEF) that enable dynamic security control by blocking the +malicious traffic or malicious end users. -R-79224: The VNF **MUST** have the chef-client be preloaded with validator -keys and configuration to register with the designated Chef Server as part -of the installation process. +R-32636 The VNF **MUST** support API-based monitoring to take care of +the scenarios where the control interfaces are not exposed, or are +optimized and proprietary in nature. -R-12467: The VNF **MUST NOT** use the SHA, DSS, MD5, SHA-1 and Skipjack -algorithms or other compromised encryption. +R-61648 The VNF **MUST** support event logging, formats, and delivery +tools to provide the required degree of event data to ONAP. -R-68589: The VNF **MUST**, if not using the NCSP’s IDAM API, support -User-IDs and passwords to uniquely identify the user/application. VNF -needs to have appropriate connectors to the Identity, Authentication and -Authorization systems that enables access at OS, Database and Application -levels as appropriate. +R-22367 The VNF **MUST** support detection of malformed packets due to +software misconfiguration or software vulnerability. -R-26115: The VNF **MUST** follow the data model upgrade rules defined in -[RFC6020] section 10. All deviations from section 10 rules shall be handled -by a built-in automatic upgrade mechanism. +R-31961 The VNF **MUST** support integrated DPI/monitoring functionality +as part of VNFs (e.g., PGW, MME). -R-49145: The VNF **MUST** implement **:confirmed-commit** If **:candidate** -is supported. +R-20912 The VNF **MUST** support alternative monitoring capabilities +when VNFs do not expose data or control traffic or use proprietary and +optimized protocols for inter VNF communication. -R-04298: The VNF provider **MUST** provide their testing scripts to -support testing. +R-73223 The VNF **MUST** support proactive monitoring to detect and +report the attacks on resources so that the VNFs and associated VMs can +be isolated, such as detection techniques for resource exhaustion, namely +OS resource attacks, CPU attacks, consumption of kernel memory, local +storage attacks. -R-92935: The VNF **SHOULD** minimize the propagation of state information -across multiple data centers to avoid cross data center traffic. +R-58370 The VNF **MUST** coexist and operate normally with commercial +anti-virus software which shall produce alarms every time when there is a +security incident. -R-47204: The VNF **MUST** protect the confidentiality and integrity of -data at rest and in transit from unauthorized access and modification. +R-56920 The VNF **MUST** protect all security audit logs (including +API, OS and application-generated logs), security audit software, data, +and associated documentation from modification, or unauthorized viewing, +by standard OS access control mechanisms, by sending to a remote system, +or by encryption. -R-32695: The VNF **MUST** provide the ability to modify the number of -retries, the time between retries and the behavior/action taken after -the retries have been exhausted for exception handling to allow the NCSP -to control that behavior. +R-54520 The VNF **MUST** log successful and unsuccessful login attempts. -R-58964: The VNF **MUST** provide the capability to restrict read and -write access to data. +R-55478 The VNF **MUST** log logoffs. -R-73364: The VNF **MUST** support at least two major versions of the -VNF software and/or sub-components to co-exist within production -environments at any time so that upgrades can be applied across multiple -systems in a staggered manner. +R-08598 The VNF **MUST** log successful and unsuccessful changes to +a privilege level. -R-33946: The VNF **MUST** conform to the NETCONF RFC 4741, -“NETCONF Configuration Protocol”. +R-13344 The VNF **MUST** log starting and stopping of security +logging. -R-24269: The VNF **SHOULD** conform its YANG model to RFC 7407, -“A YANG Data Model for SNMP Configuration”. +R-07617 The VNF **MUST** log creating, removing, or changing the +inherent privilege level of users. -R-16039: The VNF **SHOULD** test for adherence to the defined resiliency -rating recommendation at each layer, during each delivery cycle so that -the resiliency rating is measured and feedback is provided where software -resiliency requirements are not met. +R-94525 The VNF **MUST** log connections to a network listener of the +resource. -R-46290: The VNF **MUST** respond to an ONAP request to deliver granular -data on device or subsystem status or performance, referencing the YANG -configuration model for the VNF by returning the requested data elements. +R-31614 The VNF **MUST** log the field “event type” in the security +audit logs. -R-11240: The VNF **MUST** respond with content encoded in JSON, as described -in the RESTCONF specification. This way the encoding of a synchronous -communication will be consistent with Avro. +R-97445 The VNF **MUST** log the field “date/time” in the security +audit logs. -R-83790: The VNF **MUST** implement the **:validate** capability +R-25547 The VNF **MUST** log the field “protocol” in the security audit logs. -R-83873: The VNF **MUST** support **:rollback-on-error** value for the -<error-option> parameter to the <edit-config> operation. If any error -occurs during the requested edit operation, then the target database -(usually the running configuration) will be left affected. This provides an -'all-or-nothing' edit mode for a single <edit-config> request. +R-06413 The VNF **MUST** log the field “service or program used for +access” in the security audit logs. -R-25238: The VNF PACKAGE **MUST** validated YANG code using the open -source pyang [3]_ program using the following commands: +R-15325 The VNF **MUST** log the field “success/failure” in the +security audit logs. -R-58370: The VNF **MUST** coexist and operate normally with commercial -anti-virus software which shall produce alarms every time when there is -a security incident. +R-89474 The VNF **MUST** log the field “Login ID” in the security audit logs. -R-39604: The VNF **MUST** provide the capability of testing the validity -of a digital certificate by checking the Certificate Revocation List (CRL) -for the certificates of that type to ensure that the certificate has not -been revoked. +R-04982 The VNF **MUST NOT** include an authentication credential, +e.g., password, in the security audit logs, even if encrypted. -R-06617: The VNF **MUST** support get-schema (ietf-netconf-monitoring) -to pull YANG model over session. +R-63330 The VNF **MUST** detect when the security audit log storage +medium is approaching capacity (configurable) and issue an alarm via +SMS or equivalent as to allow time for proper actions to be taken to +pre-empt loss of audit data. -R-13344: The VNF **MUST** log starting and stopping of security logging. +R-41252 The VNF **MUST** support the capability of online storage of +security audit logs. -R-02360: The VNFC **MUST** be designed as a standalone, executable process. +R-41825 The VNF **MUST** activate security alarms automatically when +the following event is detected: configurable number of consecutive +unsuccessful login attempts -R-80070: The VNF **MUST** handle errors and exceptions so that they do not -interrupt processing of incoming VNF requests to maintain service continuity. +R-43332 The VNF **MUST** activate security alarms automatically when +the following event is detected: successful modification of critical +system or application files -R-02137: The VNF **MUST** implement all monitoring and logging as described -in the Security Analytics section. +R-74958 The VNF **MUST** activate security alarms automatically when +the following event is detected: unsuccessful attempts to gain permissions +or assume the identity of another user -R-16496: The VNF **MUST** enable instantiating only the functionality that -is needed for the decomposed VNF (e.g., if transcoding is not needed it -should not be instantiated). +R-15884 The VNF **MUST** include the field “date” in the Security alarms +(where applicable and technically feasible). + +R-23957 The VNF **MUST** include the field “time” in the Security alarms +(where applicable and technically feasible). + +R-71842 The VNF **MUST** include the field “service or program used for +access” in the Security alarms (where applicable and technically feasible). + +R-57617 The VNF **MUST** include the field “success/failure” in the +Security alarms (where applicable and technically feasible). + +R-99730 The VNF **MUST** include the field “Login ID” in the Security +alarms (where applicable and technically feasible). + +R-29705 The VNF **MUST** restrict changing the criticality level of a +system security alarm to administrator(s). + +R-13627 The VNF **MUST** monitor API invocation patterns to detect +anomalous access patterns that may represent fraudulent access or other +types of attacks, or integrate with tools that implement anomaly and +abuse detection. + +R-21819 The VNF **MUST** support requests for information from law +enforcement and government agencies. + +R-56786 The VNF **MUST** implement “Closed Loop” automatic implementation +(without human intervention) for Known Threats with detection rate in low +false positives. -R-32217: The VNF **MUST** have routable FQDNs that are reachable via the -Ansible Server for the endpoints (VMs) of a VNF on which playbooks will be -executed. ONAP will initiate requests to the Ansible Server for invocation -of playbooks against these end points [4]_. +R-25094 The VNF **MUST** perform data capture for security functions. -R-47849: The VNF provider **MUST** support the metadata about licenses -(and their applicable entitlements) as defined in this document for VNF -software, and any license keys required to authorize use of the VNF software. +R-04492 The VNF **MUST** generate security audit logs that must be sent +to Security Analytics Tools for analysis. - This metadata will be used to facilitate onboarding the VNF into the ONAP - environment and automating processes for putting the licenses into use and - managing the full lifecycle of the licenses. The details of this license - model are described in Appendix C. Note: License metadata support in ONAP is - not currently available and planned for 1Q 2018. +R-19219 The VNF **MUST** provide audit logs that include user ID, dates, +times for log-on and log-off, and terminal location at minimum. + +R-30932 The VNF **MUST** provide security audit logs including records +of successful and rejected system access data and other resource access +attempts. + +R-54816 The VNF **MUST** support the storage of security audit logs +for agreed period of time for forensic analysis. + +R-57271 The VNF **MUST** provide the capability of generating security +audit logs by interacting with the operating system (OS) as appropriate. + +R-84160 The VNF **MUST** have security logging for VNFs and their +OSs be active from initialization. Audit logging includes automatic +routines to maintain activity records and cleanup programs to ensure +the integrity of the audit/logging systems. + +R-58964 The VNF **MUST** provide the capability to restrict read +and write access to data. + +R-99112 The VNF **MUST** provide the capability to restrict access +to data to specific users. + +R-83227 The VNF **MUST** Provide the capability to encrypt data in +transit on a physical or virtual network. + +R-32641 The VNF **MUST** provide the capability to encrypt data on +non-volatile memory. + +R-13151 The VNF **SHOULD** disable the paging of the data requiring +encryption, if possible, where the encryption of non-transient data is +required on a device for which the operating system performs paging to +virtual memory. If not possible to disable the paging of the data +requiring encryption, the virtual memory should be encrypted. + +R-93860 The VNF **MUST** provide the capability to integrate with an +external encryption service. -R-85419: The VNF **SHOULD** use REST APIs exposed to Client Applications for -the implementation of OAuth 2.0 Authorization Code Grant and Client Credentials -Grant, as the standard interface for a VNF. +R-73067 The VNF **MUST** use industry standard cryptographic algorithms +and standard modes of operations when implementing cryptography. -R-34660: The VNF **MUST** use the RESTCONF/NETCONF framework used by the -ONAP configuration subsystem for synchronous communication. +R-22645 The VNF **SHOULD** use commercial algorithms only when there +are no applicable governmental standards for specific cryptographic +functions, e.g., public key cryptography, message digests. -R-88026: The VNF **MUST** include a NETCONF server enabling runtime -configuration and lifecycle management capabilities. +R-12467 The VNF **MUST NOT** use the SHA, DSS, MD5, SHA-1 and +Skipjack algorithms or other compromised encryption. -R-48080: The VNF **SHOULD** support SCEP (Simple Certificate Enrollment -Protocol). +R-02170 The VNF **MUST** use, whenever possible, standard implementations +of security applications, protocols, and format, e.g., S/MIME, TLS, SSH, +IPSec, X.509 digital certificates for cryptographic implementations. +These implementations must be purchased from reputable vendors and must +not be developed in-house. -R-43884: The VNF **MUST** integrate with external authentication and -authorization services (e.g., IDAM). +R-70933 The VNF **MUST** provide the ability to migrate to newer +versions of cryptographic algorithms and protocols with no impact. -R-70933: The VNF **MUST** provide the ability to migrate to newer versions -of cryptographic algorithms and protocols with no impact. +R-44723 The VNF **MUST** use symmetric keys of at least 112 bits in length. -R-48917: The VNF **MUST** monitor for and alert on (both sender and receiver) -errant, running longer than expected and missing file transfers, so as to -minimize the impact due to file transfer errors. +R-25401 The VNF **MUST** use asymmetric keys of at least 2048 bits in length. -R-79107: The VNF **MUST**, if not using the NCSP’s IDAM API, enforce a -configurable maximum number of Login attempts policy for the users. VNF -provider must comply with "terminate idle sessions" policy. Interactive -sessions must be terminated, or a secure, locking screensaver must be -activated requiring authentication, after a configurable period of inactivity. -The system-based inactivity timeout for the enterprise identity and access -management system must also be configurable. +R-95864 The VNF **MUST** use commercial tools that comply with X.509 +standards and produce x.509 compliant keys for public/private key generation. -R-75850: The VNF **SHOULD** decouple persistent data from the VNFC and keep -it in its own datastore that can be reached by all instances of the VNFC -requiring the data. +R-12110 The VNF **MUST NOT** use keys generated or derived from +predictable functions or values, e.g., values considered predictable +include user identity information, time of day, stored/transmitted data. -R-46960: The VNF **MUST** utilize only the Guest OS versions that are -supported by the NCSP’s Network Cloud. [5]_ +R-52060 The VNF **MUST** provide the capability to configure encryption +algorithms or devices so that they comply with the laws of the jurisdiction +in which there are plans to use data encryption. -R-21210: The VNF **MUST** implement the following input validation control: -Validate that any input file has a correct and valid Multipurpose Internet -Mail Extensions (MIME) type. Input files should be tested for spoofed MIME -types. +R-69610 The VNF **MUST** provide the capability of using certificates +issued from a Certificate Authority not provided by the VNF provider. -R-24359: The VNF **MUST** provide the capability of testing the validity +R-83500 The VNF **MUST** provide the capability of allowing certificate +renewal and revocation. + +R-29977 The VNF **MUST** provide the capability of testing the validity +of a digital certificate by validating the CA signature on the certificate. + +R-24359 The VNF **MUST** provide the capability of testing the validity of a digital certificate by validating the date the certificate is being used is within the validity period for the certificate. -R-49224: The VNF **MUST** provide unique traceability of a transaction -through its life cycle to ensure quick and efficient troubleshooting. +R-39604 The VNF **MUST** provide the capability of testing the +validity of a digital certificate by checking the Certificate Revocation +List (CRL) for the certificates of that type to ensure that the +certificate has not been revoked. -R-04982: The VNF **MUST NOT** include an authentication credential, -e.g., password, in the security audit logs, even if encrypted. +R-75343 The VNF **MUST** provide the capability of testing the +validity of a digital certificate by recognizing the identity represented +by the certificate — the "distinguished name". -R-74481: The VNF **MUST** NOT require the use of a dynamic routing -protocol unless necessary to meet functional requirements. +VNF Modularity +~~~~~~~~~~~~~~~~~~ -R-98911: The VNF **MUST NOT** use any instance specific parameters for -the VNF in roles/cookbooks/recipes invoked for a VNF action. +R-37028 The VNF **MUST** be composed of one “base” module. -R-89571: The VNF **MUST** support and provide artifacts for configuration -management using at least one of the following technologies: +R-41215 The VNF **MAY** have zero to many “incremental” modules. -R-87135: The VNF **MUST** comply with NIST standards and industry best -practices for all implementations of cryptography. +R-20974 The VNF **MUST** deploy the base module first, prior to +the incremental modules. -R-04492: The VNF **MUST** generate security audit logs that must be -sent to Security Analytics Tools for analysis. +R-11200 The VNF **MUST** keep the scope of a Cinder volume module, +when it exists, to be 1:1 with the VNF Base Module or Incremental Module. -R-02597: The VNF **MUST** implement the protocol operation: -**lock(target)** - Lock the configuration datastore target. +R-38474 The VNF **MUST** have a corresponding environment file for +a Base Module. -R-13800: The VNF **MUST** conform to the NETCONF RFC 5277, “NETCONF -Event Notification”. +R-81725 The VNF **MUST** have a corresponding environment file for +an Incremental Module. -R-64445: The VNF **MUST** support the ability of a requestor of the service -to determine the version (and therefore capabilities) of the service so that -Network Cloud Service Provider can understand the capabilities of the service. +R-53433 The VNF **MUST** have a corresponding environment file for +a Cinder Volume Module. -R-64768: The VNF **MUST** limit the size of application data packets to -no larger than 9000 bytes for SDN network-based tunneling when guest data -packets are transported between tunnel endpoints that support guest logical -networks. +VNF Devops +~~~~~~~~~~~~~~ -R-75608: The VNF provider **MUST** provide playbooks to be loaded on the -appropriate Ansible Server. +R-46960 NCSPs **MAY** operate a limited set of Guest OS and CPU +architectures and families, virtual machines, etc. -R-61354: The VNF **MUST** implement access control list for OA&M services -(e.g., restricting access to certain ports or applications). +R-23475 VNFCs **SHOULD** be agnostic to the details of the Network Cloud +(such as hardware, host OS, Hypervisor or container technology) and must run +on the Network Cloud with acknowledgement to the paradigm that the Network +Cloud will continue to rapidly evolve and the underlying components of +the platform will change regularly. -R-62468: The VNF **MUST** allow all configuration data to be edited through -a NETCONF <edit-config> operation. Proprietary NETCONF RPCs that make -configuration changes are not sufficient. +R-33846 The VNF **MUST** install the NCSP required software on Guest OS +images when not using the NCSP provided Guest OS images. [5]_ -R-34552: The VNF **MUST** provide or support the Identity and Access -Management (IDAM) based threat detection data for OWASP Top 10. +R-09467 The VNF **MUST** utilize only NCSP standard compute flavors. [5]_ -R-29977: The VNF **MUST** provide the capability of testing the validity of -a digital certificate by validating the CA signature on the certificate. +R-02997 The VNF **MUST** preserve their persistent data. Running VMs +will not be backed up in the Network Cloud infrastructure. -R-67709: The VNF **MUST** be designed, built and packaged to enable -deployment across multiple fault zones (e.g., VNFCs deployed in different -servers, racks, OpenStack regions, geographies) so that in the event of a -planned/unplanned downtime of a fault zone, the overall operation/throughput -of the VNF is maintained. +R-29760 The VNFC **MUST** be installed on non-root file systems, +unless software is specifically included with the operating system +distribution of the guest image. -R-46567: The VNF Package **MUST** include configuration scripts for boot -sequence and configuration. +R-20860 The VNF **MUST** be agnostic to the underlying infrastructure +(such as hardware, host OS, Hypervisor), any requirements should be +provided as specification to be fulfilled by any hardware. -R-55345: The VNF **SHOULD** use techniques such as “lazy loading” when -initialization includes loading catalogues and/or lists which can grow over -time, so that the VNF startup time does not grow at a rate proportional to -that of the list. +R-89800 The VNF **MUST NOT** require Hypervisor-level customization +from the cloud provider. -R-88482: The VNF **SHOULD** use REST using HTTPS delivery of plain text -JSON for moderate sized asynchronous data sets, and for high volume data -sets when feasible. +R-86758 The VNF **SHOULD** provide an automated test suite to validate +every new version of the software on the target environment(s). The tests +should be of sufficient granularity to independently test various +representative VNF use cases throughout its lifecycle. Operations might +choose to invoke these tests either on a scheduled basis or on demand to +support various operations functions including test, turn-up and +troubleshooting. -R-56786: The VNF **MUST** implement “Closed Loop” automatic implementation -(without human intervention) for Known Threats with detection rate in low -false positives. +R-39650 The VNF **SHOULD** provide the ability to test incremental +growth of the VNF. -R-94525: The VNF **MUST** log connections to a network listener of the -resource. +R-14853 The VNF **MUST** respond to a "move traffic" [2]_ command +against a specific VNFC, moving all existing session elsewhere with +minimal disruption if a VNF provides a load balancing function across +multiple instances of its VNFCs. Note: Individual VNF performance +aspects (e.g., move duration or disruption scope) may require further +constraints. -R-26371: The VNF **MUST** detect connectivity failure for inter VNFC instance -and intra/inter VNF and re-establish connectivity automatically to maintain -the VNF without manual intervention to provide service continuity. +R-06327 The VNF **MUST** respond to a "drain VNFC" [2]_ command against +a specific VNFC, preventing new session from reaching the targeted VNFC, +with no disruption to active sessions on the impacted VNFC, if a VNF +provides a load balancing function across multiple instances of its VNFCs. +This is used to support scenarios such as proactive maintenance with no +user impact. -R-35851: The VNF Package **MUST** include VNF topology that describes basic -network and application connectivity internal and external to the VNF -including Link type, KPIs, Bandwidth, latency, jitter, QoS (if applicable) -for each interface. +R-64713 The VNF **SHOULD** support a software promotion methodology +from dev/test -> pre-prod -> production in software, development & +testing and operations. -R-29301: The VNF **MUST** provide or support the Identity and Access -Management (IDAM) based threat detection data for Password Attacks. +**VNF Modeling Requirements** +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -R-23957: The VNF **MUST** include the field “time” in the Security alarms -(where applicable and technically feasible). +Heat +~~~~~~ -R-32636: The VNF **MUST** support API-based monitoring to take care of the -scenarios where the control interfaces are not exposed, or are optimized -and proprietary in nature. +R-43125 The VNF Heat **MUST** indent properties and lists with 1 or +more spaces. -R-39562: The VNF **MUST** disable unnecessary or vulnerable cgi-bin programs. +R-67888 The VNF Heat **MUST** contain the following +sections: -R-77334: The VNF **MUST** allow configurations and configuration parameters -to be managed under version control to ensure consistent configuration -deployment, traceability and rollback. +- heat\_template\_version: +- description: +- parameters: +- resources: -R-44723: The VNF **MUST** use symmetric keys of at least 112 bits in length. +R-39402 The VNF Heat **MUST** contain the description section. -R-86585: The VNFC **SHOULD** minimize the use of state within a VNFC to -facilitate the movement of traffic from one instance to another. +R-35414 The VNF Heat **MUST** contain the parameter section. -R-18725: The VNF **MUST** handle the restart of a single VNFC instance -without requiring all VNFC instances to be restarted. +R-90279 The VNF Heat **MUST** use in a resource all parameters declared in +a template except for the parameters for the OS::Nova::Server property +availability\_zone. See Property: availability\_zone. for more details on +availability\_zone. -R-53317: The VNF **MUST** conform its YANG model to RFC 6087, -“Guidelines for Authors and Reviewers of YANG Data Model Documents”. +R-28657 The VNF Heat **MUST** provide the attribute 'type' on +parameters per the OpenStack Heat Orchestration Template standard. -R-67114: The VNF **MUST** be installed with: +R-44001 The VNF Heat **MUST** provide the attribute 'description' +on parameters. (Note that this attribute is OpenStack optional.) -R-28168: The VNF **SHOULD** use an appropriately configured logging level -that can be changed dynamically, so as to not cause performance degradation -of the VNF due to excessive logging. +R-90526 The VNF Heat **MUST NOT** use the attribute 'default'. +If a parameter has a default value, it must be provided in +the environment file. (Note that this attribute is OpenStack +optional.) -R-54930: The VNF **MUST** implement the following input validation control: -Do not permit input that contains content or characters inappropriate to the -input expected by the design. Inappropriate input, such as SQL insertions, -may cause the system to execute undesirable and unauthorized transactions -against the database or allow other inappropriate access to the internal -network. +R-88863 The VNF Heat **MUST** have a constraint of range or +allowed\_values for a parameter type 'number'. -R-55830: The VNF **MUST** distribute all production code from NCSP internal -sources only. No production code, libraries, OS images, etc. shall be -distributed from publically accessible depots. +- range: The range constraint applies to parameters of type number. + It defines a lower and upper limit for the numeric value of the + parameter. The syntax of the range constraint is -R-22367: The VNF **MUST** support detection of malformed packets due to -software misconfiguration or software vulnerability. +R-23664 The VNF Heat **MUST** have a resources: section with the +declaration of at least one resource. -R-93860: The VNF **MUST** provide the capability to integrate with an -external encryption service. +R-16447 The VNF Heat **MUST** have unique resource IDs across all Heat +Orchestration Templates that compose the VNF. This requirement +also applies when a VNF is composed of more than one Heat +Orchestration Template (see ONAP VNF Modularity Overview). -R-09467: The VNF **MUST** utilize only NCSP standard compute flavors. [5]_ +R-97199 The VNF Heat **MUST** use the metadata property for +OS::Nova::Server resource type. -R-62170: The VNF **MUST** over-ride any default values for configurable -parameters that can be set by ONAP in the roles, cookbooks and recipes. +R-03324 The VNF Heat **MUST** contain the following sections in the +environment file: -R-41994: The VNF **MUST**, if not using the NCSP’s IDAM API, comply with -"No Self-Signed Certificates" policy. Self-signed certificates must be used -for encryption only, using specified and approved encryption protocols such -as TLS 1.2 or higher or equivalent security protocols such as IPSec, AES. +- parameters: -R-38474: The VNF **MUST** have a corresponding environment file for -a Base Module. +R-19473 The VNF Heat **MUST** include “base” in the filename for the +base module. -R-81725: The VNF **MUST** have a corresponding environment file for -an Incremental Module. +R-81339 The VNF Heat **MUST** match one of the following options for +the base module file name: -R-53433: The VNF **MUST** have a corresponding environment file for a -Cinder Volume Module. +- base\_<text>.y[a]ml +- <text>\_base.y[a]ml +- base.y[a]ml +- <text>\_base\_<text>.y[a]ml -R-84160: The VNF **MUST** have security logging for VNFs and their OSs be -active from initialization. Audit logging includes automatic routines to -maintain activity records and cleanup programs to ensure the integrity of -the audit/logging systems. +R-91342 The VNF Heat **MUST** name the base module’s corresponding +environment file to be identical to the base module with “.y[a]ml” +replaced with “.env”. -R-99656: The VNF **MUST** NOT terminate stable sessions if a VNFC instance -fails. +R-87247 The VNF Heat **MUST NOT** use any special characters or the +word “base” in the name of the incremental module. -R-80898: The VNF **MUST** support heartbeat via a <get> with null filter. +- <text>.y[a]ml -R-20974: The VNF **MUST** deploy the base module first, prior to the -incremental modules. +R-94509 The VNF Heat **MUST** name the incremental module’s +corresponding environment file to be identical to the incremental +module with “.y[a]ml” replaced with “.env”. -R-69610: The VNF **MUST** provide the capability of using certificates -issued from a Certificate Authority not provided by the VNF provider. +R-82732 The VNF Heat **MUST** name the Cinder volume module file name +to be the same as the corresponding module it is supporting (base +module or incremental module) with “\_volume” appended. -R-27310: The VNF Package **MUST** include all relevant Chef artifacts -(roles/cookbooks/recipes) required to execute VNF actions requested by -ONAP for loading on appropriate Chef Server. +- <base module name>\_volume.y[a]ml +- <incremental module name>\_volume.y[a]ml -R-98191: The VNF **MUST** vary the frequency that asynchronous data is -delivered based on the content and how data may be aggregated or grouped -together. For example, alarms and alerts are expected to be delivered as -soon as they appear. In contrast, other content, such as performance -measurements, KPIs or reported network signaling may have various ways of -packaging and delivering content. Some content should be streamed immediately; -or content may be monitored over a time interval, then packaged as collection -of records and delivered as block; or data may be collected until a package of -a certain size has been collected; or content may be summarized statistically -over a time interval, or computed as a KPI, with the summary or KPI being -delivered. - -R-31412: The VNF **MUST** provide or support the Identity and Access -Management (IDAM) based threat detection data for XSS / CSRF. +R-31141 The VNF Heat **MUST** name the volume module’s corresponding +environment file to be identical to the volume module with “.y[a]ml” +replaced with “.env”. -R-58775: The VNF provider **MUST** provide software components that can be -packaged with/near the VNF, if needed, to simulate any functions or systems -that connect to the VNF system under test. This component is necessary only -if the existing testing environment does not have the necessary simulators. +R-76057 The VNF Heat **MUST NOT** use special characters +or the word “base” in the file name for the nested template. -R-45496: The VNF **MUST** host connectors for access to the OS -(Operating System) layer. +R-18224 The VNF Heat **MUST** pass in as properties all parameter values +associated with the nested heat file in the resource definition defined +in the parent heat template. -R-13151: The VNF **SHOULD** disable the paging of the data requiring -encryption, if possible, where the encryption of non-transient data is -required on a device for which the operating system performs paging to -virtual memory. If not possible to disable the paging of the data requiring -encryption, the virtual memory should be encrypted. +R-07443 The VNF Heat **MUST** match the Output parameter name and type with +the input parameter name and type unless the Output parameter is of the +type comma\_delimited\_list. -R-49308: The VNF **SHOULD** test for adherence to the defined resiliency -rating recommendation at each layer, during each delivery cycle with -delivered results, so that the resiliency rating is measured and the code -is adjusted to meet software resiliency requirements. +R-23983 The VNF **MUST** pass the external networks into the VNF Heat +Orchestration Templates as parameters. -R-74763: The VNF provider **MUST** provide an artifact per VNF that contains -all of the VNF Event Records supported. The artifact should include reference -to the specific release of the VNF Event Stream Common Event Data Model -document it is based on. (e.g., `VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__) +- Neutron Network-id (UUID) +- Neutron Network subnet ID (UUID) +- Contrail Network Fully Qualified Domain Name (FQDN) -R-54373: The VNF **MUST** have Python >= 2.7 on the endpoint VM(s) of a -VNF on which an Ansible playbook will be executed. +R-63345 The VNF Heat **MUST** pass the appropriate external +network IDs into nested VM templates when nested Heat is used. -R-60106: The VNF **MUST** implement the protocol operation: -**get(filter)** - Retrieve (a filtered subset of) the running configuration -and device state information. This should include the list of VNF supported -schemas. +R-35666 The VNF Heat **MUST** include the resource(s) to +create the internal network. The internal network must be either a +Neutron Network or a Contrail Network. -R-95864: The VNF **MUST** use commercial tools that comply with X.509 -standards and produce x.509 compliant keys for public/private key generation. +R-86972 The VNF Heat **MUST** create internal networks in the Base +Module, in the modular approach, with their resource IDs exposed as outputs +(i.e., ONAP Base Module Output Parameters) for use by all incremental +modules. If the Network resource ID is required in the base template, +then a get\_resource must be used. -R-23475: The VNF **SHOULD** utilize only NCSP provided Guest OS images. [5]_ +R-68936 The VNF Heat **SHOULD** assign a unique +{network-role} in the context of the VNF, when the internal network is +created. ONAP Resource ID and Parameter Naming Convention provides +additional details. -R-64503: The VNF **MUST** provide minimum privileges for initial and -default settings for new user accounts. +R-01455 The VNF Heat **MUST** assign a VNF unique +{vm-type} for each Virtual Machine type (i.e., OS::Nova::Server) +instantiated in the VNF. While the {vm-type} must be unique to the VNF, +it does not have to be globally unique across all VNFs that ONAP +supports. -R-42681: The VNF **MUST** use the NCSP’s IDAM API or comply with the -requirements if not using the NCSP’s IDAM API, for identification, -authentication and access control of OA&M and other system level functions. +R-82481 The VNF Heat **MUST** include {vm-type} as part of the parameter name +for any parameter that is associated with a unique Virtual Machine type. -R-19219: The VNF **MUST** provide audit logs that include user ID, dates, -times for log-on and log-off, and terminal location at minimum. +R-66729 The VNF Heat **MUST** include {vm-type} as part of the resource ID +for any resource ID that is associated with a unique Virtual Machine type in +the VNF. -R-73067: The VNF **MUST** use industry standard cryptographic algorithms -and standard modes of operations when implementing cryptography. +R-32394 The VNF Heat **MUST** use the same case for {vm-type} for all +parameter names in the VNF. -R-25878: The VNF **MUST** use certificates issued from publicly recognized -Certificate Authorities (CA) for the authentication process where PKI-based -authentication is used. - -R-70266: The VNF **MUST** respond to an ONAP request to deliver the current -data for any of the record types defined in Section 8.d “Data Model for -Event Records” by returning the requested record, populated with the current -field values. (Currently the defined record types include the common header -record, technology independent records such as Fault, Heartbeat, State Change, -Syslog, and technology specific records such as Mobile Flow, Signaling and -Voice Quality records. Additional record types will be added in the future -as they are standardized and become available.) - -R-70496: The VNF **MUST** implement the protocol operation: -**commit(confirmed, confirm-timeout)** - Commit candidate configuration -datastore to the running configuration. +R-46839 The VNF Heat **MUST** use the same case for {vm-type} for all +Resource IDs in the VNF. -R-19624: The VNF **MUST** encode and serialize content delivered to ONAP -using JSON (option 1). High-volume data is to be encoded and serialized -using Avro, where Avro data format are described using JSON (option 2) [6]_. +R-05008 The VNF Heat **MUST NOT** be prefixed with a common +{vm-type} identifier for the six ONAP Metadata parameters. +They are *vnf\_name*, *vnf\_id*, *vf\_module\_id*, *vf\_module\_name*, +*vm\_role*. The ONAP Metadata parameters are described in +Resource: OS::Nova::Server – Metadata Parameters. -R-25094: The VNF **MUST** perform data capture for security functions. +R-15422 The VNF Heat **MUST NOT** be prefixed with a common {vm-type} +identifier the parameter referring to the OS::Nova::Server property +availability\_zone. availability\_zone is described in +Property: ailability_zone. -R-44032: The VNF **MUST** provide or support the Identity and Access -Management (IDAM) based threat detection data for Man in the Middle (MITM). +R-21330 The VNF Heat **MUST** include the {network-role} as part of the +parameter name for any parameter that is associated with an external network. -R-47068: The VNF **MAY** expose a single endpoint that is responsible for -all functionality. +R-11168 The VNF Heat **MUST** include the {network-role} as part of the +resource ID for any resource ID that is associated with an external network +must. -R-49396: The VNF **MUST** support each VNF action by invocation of **one** -playbook [7]_. The playbook will be responsible for executing all necessary -tasks (as well as calling other playbooks) to complete the request. +R-84322 The VNF Heat **MUST** include int\_{network-role} as part of the +parameter name for any parameter that is associated with an internal network. -R-63953: The VNF **MUST** have the echo command return a zero value -otherwise the validation has failed +R-96983 The VNF Heat **MUST** include int\_{network-role} as part of the +resource ID for any resource ID that is associated with an internal network. -R-56904: The VNF **MUST** interoperate with the ONAP (SDN) Controller so that -it can dynamically modify the firewall rules, ACL rules, QoS rules, virtual -routing and forwarding rules. +R-58424 The VNF Heat **MUST** use the same case for {network-role} for +all parameter names in the VNF. -R-37929: The VNF **MUST** accept all necessary instance specific data -from the environment or node object attributes for the VNF in -roles/cookbooks/recipes invoked for a VNF action. +R-21511 The VNF Heat **MUST** use the same case for {network-role} for +all Resource IDs in the VNF. -R-84366: The VNF Package **MUST** include documentation describing VNF -Functional APIs that are utilized to build network and application services. -This document describes the externally exposed functional inputs and outputs -for the VNF, including interface format and protocols supported. +R-59629 The VNF Heat **MUST** have unique resource IDs within the +resources section of a Heat Orchestration Template. This is an +OpenStack Requirement. -R-58421: The VNF **SHOULD** be decomposed into granular re-usable VNFCs. +R-43319 The VNF Heat **MUST** have unique resource IDs +across all modules that compose the VNF, +when a VNF is composed of more than one Heat Orchestration Template +(i.e., modules). -R-27711: The VNF provider **MUST** provide an XML file that contains a -list of VNF error codes, descriptions of the error, and possible -causes/corrective action. +R-54517 The VNF Heat **MUST** include {vm-type} in the resource ID +when a resource is associated with a single {vm-type}. -R-78282: The VNF **MUST** conform to the NETCONF RFC 6242, “Using the -Network Configuration Protocol over Secure Shell”. +R-96482 The VNF Heat **MUST** include {network-role} in the resource ID +when a resource is associated with a single external network. -R-99766: The VNF **MUST** allow configurations and configuration parameters -to be managed under version control to ensure the ability to rollback to a -known valid configuration. +R-98138 The VNF Heat **MUST** include int\_{network-role} in the resource ID +when a resource is associated with a single internal network. -R-89010: The VNF **MUST** survive any single points of software failure -internal to the VNF (e.g., in memory structures, JMS message queues). +R-82115 The VNF Heat **MUST** include both the {vm-type} and +{network-role} in the resource ID, +when a resource is associated with a single {vm-type} and a single +external network. -R-77667: The VNF **MUST** test for adherence to the defined performance -budget at each layer, during each delivery cycle so that the performance -budget is measured and feedback is provided where the performance budget -is not met. +- The {vm-type} must appear before the {network-role} and must be + separated by an underscore (i.e., {vm-type}\_{network-role}). +- Note that an {index} value may separate the {vm-type} and the + {network-role}. An underscore will separate the three values (i.e., + {vm-type}\_{index}\_{network-role}). -R-21652: The VNF **MUST** implement the following input validation control: -Check the size (length) of all input. Do not permit an amount of input so -great that it would cause the VNF to fail. Where the input may be a file, -the VNF API must enforce a size limit. +R-82551 The VNF Heat **MUST** include both the {vm-type} and +int\_{network-role} in the resource ID, +when a resource is associated with a single {vm-type} and a single +internal network. -R-54190: The VNF **MUST** release locks to prevent permanent lock-outs -when/if a session applying the lock is terminated (e.g., SSH session -is terminated). +- The {vm-type} must appear before the int\_{network-role} and must be + separated by an underscore (i.e., {vm-type}\_int\_{network-role}). +- Note that an {index} value may separate the {vm-type} and the + int\_{network-role}. An underscore will separate the three values + (i.e., {vm-type}\_{index}\_int\_{network-role}). -R-12271: The VNF **SHOULD** conform its YANG model to RFC 7223, -“IANA Interface Type YANG Module”. +R-69287 The VNF Heat **MUST** use only alphanumeric characters and “\_” +underscores in the resource ID. Special characters must not be used. -R-25547: The VNF **MUST** log the field “protocol” in the security audit logs. +R-71152 The VNF Heat **MUST** declare as type: string the parameter +for property image. -R-22286: The VNF **MUST** support Integration functionality via -API/Syslog/SNMP to other functional modules in the network -(e.g., PCRF, PCEF) that enable dynamic security control by blocking the -malicious traffic or malicious end users +R-91125 The VNF Heat **MUST** enumerate the parameter for property +image in the Heat Orchestration Template environment file. -R-16560: The VNF **MUST** conduct a resiliency impact assessment for all -inter/intra-connectivity points in the VNF to provide an overall resiliency -rating for the VNF to be incorporated into the software design and -development of the VNF. +R-57282 The VNF Heat **MUST** have a separate parameter for image for +Each VM type (i.e., {vm-type}) even if more than one {vm-type} shares +the same image. This provides maximum clarity and flexibility. -R-99112: The VNF **MUST** provide the capability to restrict access to -data to specific users. +R-50436 The VNF Heat **MUST** declare the parameter property for +flavor as type: string. -R-02997: The VNF **MUST** preserve their persistent data. Running VMs -will not be backed up in the Network Cloud infrastructure. +R-69431 The VNF Heat **MUST** enumerate the parameter for property +flavor in the Heat Orchestration Template environment file. -R-19367: The VNF **MUST** monitor API invocation patterns to detect -anomalous access patterns that may represent fraudulent access or other -types of attacks, or integrate with tools that implement anomaly and abuse -detection. +R-40499 The VNF Heat **MUST** have a separate parameter for flavor for each +VM type (i.e., {vm-type}) even if more than one {vm-type} shares the same +flavor. This provides maximum clarity and flexibility. -R-33981: The VNF **SHOULD** interoperate with various access control -mechanisms for the Network Cloud execution environment (e.g., Hypervisors, -containers). +R-22838 The VNF Heat **MUST NOT** enumerate the parameter for property name +in the environment file. -R-26881: The VNF provider **MUST** provide the binaries and images -needed to instantiate the VNF (VNF and VNFC images). +R-51430 The VNF Heat **MUST** declare the parameter for property name as +type: string or type: comma\_delimited\_list -R-69565: The VNF Package **MUST** include documentation describing VNF -Management APIs. The document must include information and tools for: +R-98450 The VNF Heat **MUST** name the parameter availability\_zone\_{index} +in the Heat Orchestration Template. -R-92571: The VNF **MUST** provide operational instrumentation such as -logging, so as to facilitate quick resolution of issues with the VNF to -provide service continuity. +R-13561 The VNF Heat **MUST** start the {index} at zero. -R-29488: The VNF **MUST** implement the protocol operation: -**get-config(source, filter)** - Retrieve a (filtered subset of a) -configuration from the configuration datastore source. +R-60204 The VNF Heat **MUST** increment the {index} by one. -R-03070: The VNF **MUST**, by ONAP Policy, provide the ONAP addresses as -data destinations for each VNF, and may be changed by Policy while the VNF -is in operation. We expect the VNF to be capable of redirecting traffic to -changed destinations with no loss of data, for example from one REST URL -to another, or from one TCP host and port to another. +R-36887 The VNF Heat **MUST NOT** include the {vm-type} in the parameter name. -R-89800: The VNF **MUST NOT** require Hypervisor-level customization from -the cloud provider. +R-17020 The VNF Heat **MUST** include the following three mandatory +metadata parameters for an OS::Nova::Server resource: -R-12110: The VNF **MUST NOT** use keys generated or derived from -predictable functions or values, e.g., values considered predictable -include user identity information, time of day, stored/transmitted data. +- vnf\_id +- vf\_module\_id +- vnf\_name -R-03954: The VNF **MUST** survive any single points of failure within -the Network Cloud (e.g., virtual NIC, VM, disk failure). +R-55218 The VNF Heat **MUST NOT** have parameter constraints defined +for the OS::Nova::Server metadata parameter vnf\_id. -R-98391: The VNF **MUST**, if not using the NCSP’s IDAM API, support -Role-Based Access Control to permit/limit the user/application to performing -specific activities. +R-20856 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server +metadata parameter vnf\_id in environment file. -R-29967: The VNF **MUST** conform its YANG model to RFC 6022, “YANG -module for NETCONF monitoring”. +R-98374 The VNF Heat **MUST NOT** have parameter constraints +defined for the OS::Nova::Server metadata parameter vf\_module\_id. -R-80335: The VNF **MUST** make visible a Warning Notice: A formal statement -of resource intent, i.e., a warning notice, upon initial access to a VNF -provider user who accesses private internal networks or Company computer -resources, e.g., upon initial logon to an internal web site, system or -application which requires authentication. +R-72871 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server +metadata parameter vf\_module\_id in environment file. -R-48596: The VNF Package **MUST** include documentation describing the -characteristics for the VNF reliability and high availability. +R-44318 The VNF Heat **MUST NOT** have parameter constraints defined +for the OS::Nova::Server metadata parameter vnf\_name. -R-49956: The VNF **MUST** pass all access to applications (Bearer, signaling -and OA&M) through various security tools and platforms from ACLs, stateful -firewalls and application layer gateways depending on manner of deployment. -The application is expected to function (and in some cases, interwork) with -these security tools. +R-36542 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server +metadata parameter vnf\_name in the environment file. -R-02616: The VNF **MUST** permit locking at the finest granularity if a VNF -needs to lock an object for configuration to avoid blocking simultaneous -configuration operations on unrelated objects (e.g., BGP configuration -should not be locked out if an interface is being configured or entire -Interface configuration should not be locked out if a non-overlapping -parameter on the interface is being configured). +R-72050 The VNF Heat **MUST** contain {network-role} in the parameter name -R-15659: The VNF **MUST** restrict changing the criticality level of a -system security alarm to administrator(s). +R-57576 The VNF Heat **MUST** contain int\_{network-role} +in the parameter name. -R-96634: The VNF provider **MUST** describe scaling capabilities to -manage scaling characteristics of the VNF. +R-93272 The VNF Heat **MUST** adhere to the following parameter naming +convention in the Heat Orchestration Template, when the parameter +associated with the property network is referencing an “external” network: -R-32641: The VNF **MUST** provide the capability to encrypt data -on non-volatile memory. +- {network-role}\_net\_id for the Neutron network ID +- {network-role}\_net\_name for the network name in OpenStack -R-48470: The VNF **MUST** support Real-time detection and notification -of security events. +R-65373 The VNF Heat **MUST** adhere to the following parameter naming +convention, when the parameter associated with the property network is +referencing an “internal” network: -R-41825: The VNF **MUST** activate security alarms automatically when the -following event is detected: configurable number of consecutive unsuccessful -login attempts +- int\_{network-role}\_net\_id for the Neutron network ID +- int\_{network-role}\_net\_name for the network name in OpenStack -R-52870: The VNF **MUST** provide a method of metrics gathering and analysis -to evaluate the resiliency of the software from both a granular as well as a -holistic standpoint. This includes, but is not limited to thread utilization, -errors, timeouts, and retries. +R-47716 The VNF Heat **MUST** adhere to the following parameter naming +convention for the property fixed\_ips and Map Property subnet\_id +parameter, when the parameter is referencing a subnet of an +“external” network. -R-89474: The VNF **MUST** log the field “Login ID” in the security audit logs. +- {network-role}\_subnet\_id if the subnet is an IPv4 subnet +- {network-role}\_v6\_subnet\_id if the subnet is an IPv6 subnet -R-13390: The VNF provider **MUST** provide cookbooks to be loaded on -the appropriate Chef Server. +R-20106 The VNF Heat **MUST** adhere to the following naming convention for +the property fixed\_ips and Map Property subnet\_id parameter, +when the parameter is referencing the subnet of an “internal” network: -R-24825: The VNF **MUST** provide Context awareness data (device, -location, time, etc.) and be able to integrate with threat detection system. +- int\_{network-role}\_subnet\_id if the subnet is an IPv4 subnet +- int\_{network-role}\_v6\_subnet\_id if the subnet is an IPv6 subnet -R-23882: The VNF **SHOULD** be scanned using both network scanning and -application scanning security tools on all code, including underlying OS -and related configuration. Scan reports shall be provided. Remediation -roadmaps shall be made available for any findings. +R-41177 The VNF Heat **MUST** include {vm-type} and {network-role} +in the parameter name, when a SDN-C IP assignment is made to a +port connected to an external network. -R-22946: The VNF **SHOULD** conform its YANG model to RFC 6536, -“NETCONF Access Control Model”. +R-84898 The VNF Heat **MUST** adhere to the following naming convention, +when the parameter for property fixed\_ips and Map Property ip\_address +is declared type: comma\_delimited\_list: -R-89753: The VNF **MUST NOT** install or use systems, tools or utilities -capable of capturing or logging data that was not created by them or sent -specifically to them in production, without authorization of the VNF -system owner. +- {vm-type}\_{network-role}\_ips for IPv4 address +- {vm-type}\_{network-role}\_v6\_ips for IPv6 address -R-88899: The VNF **MUST** support simultaneous <commit> operations within -the context of this locking requirements framework. +R-34960 The VNF Heat **MUST** adhere to the following +naming convention, +when the parameter for property fixed\_ips and Map Property ip\_address +is declared type: string: -R-96554: The VNF **MUST** implement the protocol operation: **unlock(target)** -- Unlock the configuration datastore target. +- {vm-type}\_{network-role}\_ip\_{index} for an IPv4 address +- {vm-type}\_{network-role}\_v6\_ip\_{index} for an IPv6 address -R-27995: The VNF **SHOULD** include control loop mechanisms to notify the -consumer of the VNF of their exceeding SLA thresholds so the consumer is -able to control its load against the VNF. +R-62584 The VNF Heat **MUST** adhere to +the following naming convention, +when the parameter for property fixed\_ips and Map Property ip\_address +is declared type: comma\_delimited\_list: -R-31809: The VNF **MUST** support the HealthCheck RPC. The HealthCheck RPC, -executes a VNF providor-defined VNF Healthcheck over the scope of the entire -VNF (e.g., if there are multiple VNFCs, then run a health check, as -appropriate, for all VNFCs). It returns a 200 OK if the test completes. A -JSON object is returned indicating state (healthy, unhealthy), scope -identifier, time-stamp and one or more blocks containing info and fault -information. If the VNF is unable to run the HealthCheck, return a standard -http error code and message. +- {vm-type}\_int\_{network-role}\_ips for IPv4 address +- {vm-type}\_int\_{network-role}\_v6\_ips for IPv6 address -R-25401: The VNF **MUST** use asymmetric keys of at least 2048 bits in length. +R-29256 The VNF Heat **MUST** must adhere to the following +naming convention, +when the parameter for property fixed\_ips and Map Property ip\_address +is declared type: string: -R-31961: The VNF **MUST** support integrated DPI/monitoring functionality -as part of VNFs (e.g., PGW, MME). +- {vm-type}\_int\_{network-role}\_ip\_{index} for an IPv4 address +- {vm-type}\_int\_{network-role}\_v6\_ip\_{index} for an IPv6 address -R-47597: The VNF **MUST** carry data in motion only over secure connections. +R-61282 The VNF Heat **MUST** +adhere to the following naming convention for the property +allowed\_address\_pairs and Map Property ip\_address parameter, +when the parameter is referencing an “external” network: -R-43253: The VNF **MUST** use playbooks designed to allow Ansible Server -to infer failure or success based on the “PLAY_RECAP” capability. +- {vm-type}\_{network-role}\_floating\_ip for an IPv4 address +- {vm-type}\_{network-role}\_floating\_v6\_ip for an IPv6 address -R-23135: The VNF **MUST**, if not using the NCSP’s IDAM API, authenticate -system to system communications where one system accesses the resources -of another system, and must never conceal individual accountability. +R-16805 The VNF Heat **MUST** adhere to the following naming convention +for the property allowed\_address\_pairs and Map Property ip\_address +parameter when the parameter is referencing an “internal” network. -R-99730: The VNF **MUST** include the field “Login ID” in the -Security alarms (where applicable and technically feasible). +- {vm-type}\_int\_{network-role}\_floating\_ip for an IPv4 address +- {vm-type}\_int\_{network-role}\_floating\_v6\_ip for an IPv6 address -R-88199: The VNF **MUST** utilize virtualized, scalable open source -database software that can meet the performance/latency requirements -of the service for all datastores. +R-85734 The VNF Heat **MUST** use the intrinsic function str\_replace +in conjunction with the ONAP supplied metadata parameter +vnf\_name to generate a unique value, +when the property name for a non OS::Nova::Server resources is defined +in a Heat Orchestration Template. -R-08598: The VNF **MUST** log successful and unsuccessful changes to a -privilege level. +R-47788 The VNF Heat **MUST** have a 1:1 scope of a cinder volume module, +when it exists, with the Base Module or Incremental Module -R-87352: The VNF **SHOULD** utilize Cloud health checks, when available -from the Network Cloud, from inside the application through APIs to check -the network connectivity, dropped packets rate, injection, and auto failover -to alternate sites if needed. +R-79531 The VNF Heat **MUST** define “outputs” in the volume +template for each Cinder volume resource universally unique +identifier (UUID) (i.e. ONAP Volume Template Output Parameters). -R-56920: The VNF **MUST** protect all security audit logs (including API, -OS and application-generated logs), security audit software, data, and -associated documentation from modification, or unauthorized viewing, by -standard OS access control mechanisms, by sending to a remote system, -or by encryption. +R-86285 The VNF Heat **MUST** have a +corresponding environment file, even if no parameters are required to be +enumerated. -R-35291: The VNF **MUST** support the ability to failover a VNFC automatically -to other geographically redundant sites if not deployed active-active to -increase the overall resiliency of the VNF. +R-67205 The VNF Heat **MUST** have a corresponding +environment file for a Base Module. -R-43332: The VNF **MUST** activate security alarms automatically when the -following event is detected: successful modification of critical system -or application files +R-35727 The VNF Heat **MUST** have a +corresponding environment file for an Incremental module. -R-81147: The VNF **MUST** have greater restrictions for access and -execution, such as up to 3 factors of authentication and restricted -authorization, for commands affecting network services, such as -commands relating to VNFs. +R-22656 The VNF Heat **MUST** have a corresponding environment file +for a Cinder Volume Module. -R-60656: The VNF **MUST** support sub tree filtering. +R-89868 The VNF Heat **MUST** have unique file names within the scope +of the VNF for a nested heat yaml file. -R-51883: The VNF **MUST** provide or support the Identity and Access -Management (IDAM) based threat detection data for Replay. +R-52530 The VNF Heat **MUST NOT** use a directory hierarchy for +nested templates. All templates must be in a single, flat directory +(per VNF). -R-66070: The VNF Package **MUST** include VNF Identification Data to -uniquely identify the resource for a given VNF provider. The identification -data must include: an identifier for the VNF, the name of the VNF as was -given by the VNF provider, VNF description, VNF provider, and version. +R-11041 The VNF Heat **MUST** have the resource calling the +nested yaml file pass in as properties all parameters defined +in nested yaml file. -R-19804: The VNF **MUST** validate the CA signature on the certificate, -ensure that the date is within the validity period of the certificate, -check the Certificate Revocation List (CRL), and recognize the identity -represented by the certificate where PKI-based authentication is used. +R-61183 The VNF Heat **MUST NOT** change the parameter names, when +OS::Nova::Server metadata parameters are past into a nested heat template. -R-06327: The VNF **MUST** respond to a "drain VNFC" [2]_ command against a -specific VNFC, preventing new session from reaching the targeted VNFC, with -no disruption to active sessions on the impacted VNFC, if a VNF provides a -load balancing function across multiple instances of its VNFCs. This is used -to support scenarios such as proactive maintenance with no user impact. +R-76718 The VNF Heat **MUST** reference the get\_files targets in +Heat templates by file name, and the corresponding files should be +delivered to ONAP along with the Heat templates. -R-85653: The VNF **MUST** provide metrics (e.g., number of sessions,number -of subscribers, number of seats, etc.) to ONAP for tracking every license. +R-41888 The VNE Heat **MUST NOT** use URL-based file retrieval. -R-63330: The VNF **MUST** detect when the security audit log storage medium -is approaching capacity (configurable) and issue an alarm via SMS or -equivalent as to allow time for proper actions to be taken to pre-empt -loss of audit data. +R-62177 The VNF Heat **MUST** have unique file names for the included +files within the scope of the VNF. -R-22645: The VNF **SHOULD** use commercial algorithms only when there are -no applicable governmental standards for specific cryptographic functions, -e.g., public key cryptography, message digests. +R-87848 The VNF Heat **MUST** have all included files in a single, flat +directory per VNF. ONAP does not support a directory hierarchy. -R-22888: The VNF provider **MUST** provide documentation for the VNF Policy -Description to manage the VNF runtime lifecycle. The document must include -a description of how the policies (conditions and actions) are implemented -in the VNF. +- Included files may be used by all Modules within a given VNF. +- get\_file directives may be used in both non-nested and nested + templates -R-78066: The VNF **MUST** support requests for information from law -enforcement and government agencies. +**ONAP Management Requirements** +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -R-35144: The VNF **MUST**, if not using the NCSP’s IDAM API, comply with -the NCSP’s credential management policy. -R-85959: The VNF **SHOULD** automatically enable/disable added/removed -sub-components or component so there is no manual intervention required. +VNF On-boarding and package management +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -R-28756: The VNF **MUST** support **:partial-lock** and **:partial-unlock** -capabilities, defined in RFC 5717. This allows multiple independent clients -to each write to a different part of the <running> configuration at the -same time. -R-41252: The VNF **MUST** support the capability of online storage of -security audit logs. +R-77707 The VNF provider **MUST** include a Manifest File that +contains a list of all the components in the VNF package. + +R-66070 The xNF Package **MUST** include xNF Identification Data to +uniquely identify the resource for a given xNF provider. The identification +data must include: an identifier for the xNF, the name of the xNF as was +given by the xNF provider, xNF description, xNF provider, and version. + +R-69565 The xNF Package **MUST** include documentation describing +xNF Management APIs. The document must include information and +tools for: + +- ONAP to deploy and configure (initially and ongoing) the xNF + application(s) (e.g., NETCONF APIs). Includes description of + configurable parameters for the xNF and whether the parameters + can be configured after xNF instantiation. +- ONAP to monitor the health of the xNF (conditions that require + healing and/or scaling responses). Includes a description of: + +- Parameters that can be monitored for the xNF and event records + (status, fault, flow, session, call, control plane, etc.) generated + by the xNF after instantiation. +- Runtime lifecycle events and related actions (e.g., control + responses, tests) which can be performed for the xNF. + +R-84366 The xNF Package **MUST** include documentation describing +xNF Functional APIs that are utilized to build network and +application services. This document describes the externally exposed +functional inputs and outputs for the xNF, including interface +format and protocols supported. + +R-36280 The xNF provider **MUST** provide documentation describing +xNF Functional Capabilities that are utilized to operationalize the +xNF and compose complex services. + +R-98617 The xNF provider **MUST** provide information regarding any +dependency (e.g., affinity, anti-affinity) with other xNFs and resources. + +R-89571 The xNF **MUST** support and provide artifacts for +configuration management using at least one of the following +technologies: + +- NETCONF/YANG +- Chef +- Ansible + +R-30278 The xNF provider **MUST** provide a Resource/Device YANG model +as a foundation for creating the YANG model for configuration. This will +include xNF attributes/parameters and valid values/attributes configurable +by policy. + +R-13390 The xNF provider **MUST** provide cookbooks to be loaded +on the appropriate Chef Server. + +R-18525 The xNF provider **MUST** provide a JSON file for each +supported action for the xNF. The JSON file must contain key value +pairs with all relevant values populated with sample data that illustrates +its usage. The fields and their description are defined in Appendix A. + +R-75608 The xNF provider **MUST** provide playbooks to be loaded +on the appropriate Ansible Server. -R-77707: The VNF provider **MUST** include a Manifest File that contains -a list of all the components in the VNF package. +R-16777 The xNF provider **MUST** provide a JSON file for each +supported action for the xNF. The JSON file must contain key value +pairs with all relevant values populated with sample data that illustrates +its usage. The fields and their description are defined in Appendix B. -R-20860: The VNF **MUST** be agnostic to the underlying infrastructure -(such as hardware, host OS, Hypervisor), any requirements should be provided -as specification to be fulfilled by any hardware. +R-46567 The xNF Package **MUST** include configuration scripts +for boot sequence and configuration. -R-01478: The VNF Package **MUST** include documentation describing all -parameters that are available to monitor the VNF after instantiation +R-16065 The xNF provider **MUST** provide configurable parameters +(if unable to conform to YANG model) including xNF attributes/parameters +and valid values, dynamic attributes and cross parameter dependencies +(e.g., customer provisioning data). + +R-22888 The xNF provider **MUST** provide documentation for the xNF +Policy Description to manage the xNF runtime lifecycle. The document +must include a description of how the policies (conditions and actions) +are implemented in the xNF. + +R-01556 The xNF Package **MUST** include documentation describing the +fault, performance, capacity events/alarms and other event records that +are made available by the xNF. The document must include: + +- A unique identification string for the specific xNF, a description + of the problem that caused the error, and steps or procedures to + perform Root Cause Analysis and resolve the issue. +- All events, severity level (e.g., informational, warning, error) + and descriptions including causes/fixes if applicable for the event. +- All events (fault, measurement for xNF Scaling, Syslogs, State Change + and Mobile Flow), that need to be collected at each VM, VNFC + (defined in `VNF Guidelines <http://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html#a-glossary>`__ ) and for the overall xNF. + +R-27711 The xNF provider **MUST** provide an XML file that contains a +list of xNF error codes, descriptions of the error, and possible +causes/corrective action. + +R-01478 The xNF Package **MUST** include documentation describing all +parameters that are available to monitor the xNF after instantiation (includes all counters, OIDs, PM data, KPIs, etc.) that must be collected for reporting purposes. The documentation must include a list of: -R-22059: The VNF **MUST NOT** execute long running tasks (e.g., IO, database, -network operations, service calls) in a critical section of code, so as to -minimize blocking of other operations and increase concurrent throughput. +- Monitoring parameters/counters exposed for virtual resource + management and xNF application management. +- KPIs and metrics that need to be collected at each VM for capacity + planning and performance management purposes. +- The monitoring parameters must include latencies, success rates, + retry rates, load and quality (e.g., DPM) for the key + transactions/functions supported by the xNF and those that must + be exercised by the xNF in order to perform its function. +- For each KPI, provide lower and upper limits. +- When relevant, provide a threshold crossing alert point for + each KPI and describe the significance of the threshold crossing. +- For each KPI, identify the suggested actions that need to be + performed when a threshold crossing alert event is recorded. +- Describe any requirements for the monitoring component of tools + for Network Cloud automation and management to provide these records + to components of the xNF. +- When applicable, provide calculators needed to convert raw data + into appropriate reporting artifacts. + +R-56815 The xNF Package **MUST** include documentation describing +supported xNF scaling capabilities and capacity limits (e.g., number +of users, bandwidth, throughput, concurrent calls). -R-30650: The VNF **MUST** utilize cloud provided infrastructure and VNFs -(e.g., virtualized Local Load Balancer) as part of the VNF so that the cloud -can manage and provide a consistent service resiliency and methods across -all VNF's. +R-48596 The xNF Package **MUST** include documentation describing +the characteristics for the xNF reliability and high availability. -R-30654: The VNF Package **MUST** have appropriate cookbooks that are -designed to automatically ‘rollback’ to the original state in case of -any errors for actions that change state of the VNF (e.g., configure). +R-74763 The xNF provider **MUST** provide an artifact per xNF that contains +all of the xNF Event Records supported. The artifact should include reference +to the specific release of the xNF Event Stream Common Event Data Model +document it is based on. (e.g., `VES Event Listener <https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition>`__) -R-29705: The VNF **MUST** restrict changing the criticality level of a -system security alarm to administrator(s). +R-35851 The xNF Package **MUST** include xNF topology that describes +basic network and application connectivity internal and external to the +xNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if +applicable) for each interface. -R-71787: The VNF **MUST** comply with Segregation of Duties (access to a -single layer and no developer may access production without special oversight) -when persons or non-person entities access VNFs. +R-97102 The VNF Package **MUST** include VM requirements via a Heat +template that provides the necessary data for: -R-86758: The VNF **SHOULD** provide an automated test suite to validate every -new version of the software on the target environment(s). The tests should be -of sufficient granularity to independently test various representative VNF use -cases throughout its lifecycle. Operations might choose to invoke these tests -either on a scheduled basis or on demand to support various operations -functions including test, turn-up and troubleshooting. +- VM specifications for all VNF components - for hypervisor, CPU, + memory, storage. +- Network connections, interface connections, internal and external to VNF. +- High availability redundancy model. +- Scaling/growth VM specifications. -R-06885: The VNF **SHOULD** support the ability to scale down a VNFC pool -without jeopardizing active sessions. Ideally, an active session should not -be tied to any particular VNFC instance. +R-26881 The xNF provider **MUST** provide the binaries and images +needed to instantiate the xNF (xNF and VNFC images). -R-06924: The VNF **MUST** deliver asynchronous data as data becomes available, -or according to the configured frequency. +R-96634 The VNF provider **MUST** describe scaling capabilities +to manage scaling characteristics of the VNF. -R-65134: The VNF **SHOULD** maintain state in a geographically redundant -datastore that may, in fact, be its own VNFC. +R-43958 The xNF Package **MUST** include documentation describing +the tests that were conducted by the xNF providor and the test results. -R-13627: The VNF **MUST** monitor API invocation patterns to detect anomalous -access patterns that may represent fraudulent access or other types of attacks, -or integrate with tools that implement anomaly and abuse detection. +R-04298 The xNF provider **MUST** provide their testing scripts to +support testing. -R-86455: The VNF **SHOULD** support hosting connectors for OS Level and -Application Access. +R-58775 The xNF provider **MUST** provide software components that +can be packaged with/near the xNF, if needed, to simulate any functions +or systems that connect to the xNF system under test. This component is +necessary only if the existing testing environment does not have the +necessary simulators. -R-68990: The VNF **MUST** support the **:startup** capability. It will allow -the running configuration to be copied to this special database. It can also -be locked and unlocked. +R-85653 The xNF **MUST** provide metrics (e.g., number of sessions, +number of subscribers, number of seats, etc.) to ONAP for tracking +every license. -R-78010: The VNF **MUST** use the NCSP’s IDAM API for Identification, -authentication and access control of customer or VNF application users. +R-44125 The xNF provider **MUST** agree to the process that can +be met by Service Provider reporting infrastructure. The Contract +shall define the reporting process and the available reporting tools. -R-46986: The VNF **SHOULD** have source code scanned using scanning tools -(e.g., Fortify) and provide reports. +R-40827 The xNF provider **MUST** enumerate all of the open +source licenses their xNF(s) incorporate. -R-97293: The VNF provider **MUST NOT** require audits of Service Provider’s -business. +R-97293 The xNF provider **MUST NOT** require audits of +Service Provider’s business. -R-16065: The VNF provider **MUST** provide configurable parameters (if unable -to conform to YANG model) including VNF attributes/parameters and valid values, -dynamic attributes and cross parameter dependencies (e.g., customer -provisioning data). +R-44569 The xNF provider **MUST NOT** require additional +infrastructure such as a xNF provider license server for xNF provider +functions and metrics. -R-34484: The VNF **SHOULD** create a single component VNF for VNFCs that can -be used by other VNFs. +R-13613 The VNF **MUST** provide clear measurements for licensing +purposes to allow automated scale up/down by the management system. -R-30278: The VNF provider **MUST** provide a Resource/Device YANG model as a -foundation for creating the YANG model for configuration. This will include -VNF attributes/parameters and valid values/attributes configurable by policy. +R-27511 The VNF provider **MUST** provide the ability to scale +up a VNF provider supplied product during growth and scale down a +VNF provider supplied product during decline without “real-time” +restrictions based upon VNF provider permissions. -R-35401: The VNF **MUST** must support SSH and allow SSH access to the Ansible -server for the endpoint VM(s) and comply with the Network Cloud Service -Provider guidelines for authentication and access. +R-85991 The xNF provider **MUST** provide a universal license key +per xNF to be used as needed by services (i.e., not tied to a VM +instance) as the recommended solution. The xNF provider may provide +pools of Unique xNF License Keys, where there is a unique key for +each xNF instance as an alternate solution. Licensing issues should +be resolved without interrupting in-service xNFs. -R-68200: The VNF **MUST** support the **:url** value to specify protocol -operation source and target parameters. The capability URI for this feature -will indicate which schemes (e.g., file, https, sftp) that the server supports -within a particular URL value. The 'file' scheme allows for editable local -configuration databases. The other schemes allow for remote storage of -configuration databases. +R-47849 The xNF provider **MUST** support the metadata about +licenses (and their applicable entitlements) as defined in this +document for xNF software, and any license keys required to authorize +use of the xNF software. This metadata will be used to facilitate +onboarding the xNF into the ONAP environment and automating processes +for putting the licenses into use and managing the full lifecycle of +the licenses. The details of this license model are described in +Appendix C. Note: License metadata support in ONAP is not currently +available and planned for 1Q 2018. -R-41159: The VNF **MUST** deliver any and all functionality from any VNFC -in the pool. The VNFC pool member should be transparent to the client. -Upstream and downstream clients should only recognize the function being -performed, not the member performing it. +Configuration Management +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -R-18864: The VNF **MUST** NOT use technologies that bypass virtualization -layers (such as SR-IOV) unless approved by the NCSP (e.g., if necessary to -meet functional or performance requirements). +R-20741 The xNF **MUST** support ONAP Controller’s **Configure** command. -R-37028: The VNF **MUST** be composed of one “base” module. +R-19366 The xNF **MUST** support ONAP Controller’s **ConfigModify** command. -R-40827: The VNF provider **MUST** enumerate all of the open source licenses -their VNF(s) incorporate. +R-32981 The xNF **MUST** support ONAP Controller’s **ConfigBackup** command. -R-95950: The VNF **MUST** provide a NETCONF interface fully defined by -supplied YANG models for the embedded NETCONF server. +R-48247 The xNF **MUST** support ONAP Controller’s **ConfigRestore** command. -R-10716: The VNF **MUST** support parallel and simultaneous configuration -of separate objects within itself. +R-94084 The xNF **MUST** support ONAP Controller’s **ConfigScaleOut** +command. -R-71842: The VNF **MUST** include the field “service or program used for -access” in the Security alarms (where applicable and technically feasible). +R-56385 The xNF **MUST** support ONAP Controller’s **Audit** command. + +R-12706 The xNF **MUST** support ONAP Controller’s **QuiesceTraffic** +command. + +R-07251 The xNF **MUST** support ONAP Controller’s **ResumeTraffic** +command. + +R-83146 The xNF **MUST** support ONAP Controller’s **StopApplication** +command. -R-54430: The VNF **MUST** use the NCSP’s supported library and compute flavor -that supports DPDK to optimize network efficiency if using DPDK. [5]_ +R-82811 The xNF **MUST** support ONAP Controller’s **StartApplication** +command. -R-03465: The VNF **MUST** release locks to prevent permanent lock-outs when -the corresponding <partial-unlock> operation succeeds. +R-19922 The xNF **MUST** support ONAP Controller’s **UpgradePrecheck** +command. -R-65755: The VNF **SHOULD** support callback URLs to return information to -ONAP upon completion of the chef-client run for any chef-client run -associated with a VNF action. +R-49466 The xNF **MUST** support ONAP Controller’s **UpgradeSoftware** +command. + +R-45856 The xNF **MUST** support ONAP Controller’s **UpgradePostCheck** +command. + +R-97343 The xNF **MUST** support ONAP Controller’s **UpgradeBackup** +command. + +R-65641 The xNF **MUST** support ONAP Controller’s **UpgradeBackOut** +command. + +R-41430 The xNF **MUST** support ONAP Controller’s **HealthCheck** +command. + +R-88026 The xNF **MUST** include a NETCONF server enabling +runtime configuration and lifecycle management capabilities. + +R-95950 The xNF **MUST** provide a NETCONF interface fully defined +by supplied YANG models for the embedded NETCONF server. + +R-73468 The xNF **MUST** allow the NETCONF server connection +parameters to be configurable during virtual machine instantiation +through Heat templates where SSH keys, usernames, passwords, SSH +service and SSH port numbers are Heat template parameters. + +R-90007 The xNF **MUST** implement the protocol operation: +**close-session()**- Gracefully close the current session. + +R-70496 The xNF **MUST** implement the protocol operation: +**commit(confirmed, confirm-timeout)** - Commit candidate +configuration datastore to the running configuration. + +R-18733 The xNF **MUST** implement the protocol operation: +**discard-changes()** - Revert the candidate configuration +datastore to the running configuration. + +R-44281 The xNF **MUST** implement the protocol operation: +**edit-config(target, default-operation, test-option, error-option, +config)** - Edit the target configuration datastore by merging, +replacing, creating, or deleting new config elements. -R-11499: The VNF **MUST** fully support the XPath 1.0 specification for -filtered retrieval of configuration and other database contents. The 'type' -attribute within the <filter> parameter for <get> and <get-config> operations -may be set to 'xpath'. The 'select' attribute (which contains the XPath -expression) will also be supported by the server. A server may support -partial XPath retrieval filtering, but it cannot advertise the **:xpath** -capability unless the entire XPath 1.0 specification is supported. +R-60106 The xNF **MUST** implement the protocol operation: +**get(filter)** - Retrieve (a filtered subset of) the running +configuration and device state information. This should include +the list of xNF supported schemas. -R-95105: The VNF **MUST** host connectors for access to the application layer. +R-29488 The xNF **MUST** implement the protocol operation: +**get-config(source, filter)** - Retrieve a (filtered subset of +a) configuration from the configuration datastore source. -R-77157: The VNF **MUST** conform to approved request, workflow authorization, -and authorization provisioning requirements when creating privileged users. +R-11235 The xNF **MUST** implement the protocol operation: +**kill-session(session)** - Force the termination of **session**. -R-63473: The VNF **MUST** automatically advertise newly scaled components -so there is no manual intervention required. +R-02597 The xNF **MUST** implement the protocol operation: +**lock(target)** - Lock the configuration datastore target. -R-13613: The VNF **MUST** provide clear measurements for licensing purposes -to allow automated scale up/down by the management system. +R-96554 The xNF **MUST** implement the protocol operation: +**unlock(target)** - Unlock the configuration datastore target. -R-66793: The VNF **MUST** guarantee the VNF configuration integrity for -all simultaneous configuration operations (e.g., if a change is attempted to -the BUM filter rate from multiple interfaces on the same EVC, then they need -to be sequenced in the VNF without locking either configuration method out). +R-29324 The xNF **SHOULD** implement the protocol operation: +**copy-config(target, source) -** Copy the content of the +configuration datastore source to the configuration datastore target. -R-19790: The VNF **MUST NOT** include authentication credentials in -security audit logs, even if encrypted. +R-88031 The xNF **SHOULD** implement the protocol operation: +**delete-config(target) -** Delete the named configuration +datastore target. -R-97529: The VNF **SHOULD** implement the protocol operation: +R-97529 The xNF **SHOULD** implement the protocol operation: **get-schema(identifier, version, format) -** Retrieve the YANG schema. -R-84473: The VNF **MUST** enable DPDK in the guest OS for VNF’s requiring -high packets/sec performance. High packet throughput is defined as greater -than 500K packets/sec. +R-62468 The xNF **MUST** allow all configuration data to be +edited through a NETCONF <edit-config> operation. Proprietary +NETCONF RPCs that make configuration changes are not sufficient. + +R-01382 The xNF **MUST** allow the entire configuration of the +xNF to be retrieved via NETCONF's <get-config> and <edit-config>, +independently of whether it was configured via NETCONF or other +mechanisms. + +R-28756 The xNF **MUST** support **:partial-lock** and +**:partial-unlock** capabilities, defined in RFC 5717. This +allows multiple independent clients to each write to a different +part of the <running> configuration at the same time. + +R-83873 The xNF **MUST** support **:rollback-on-error** value for +the <error-option> parameter to the <edit-config> operation. If any +error occurs during the requested edit operation, then the target +database (usually the running configuration) will be left unaffected. +This provides an 'all-or-nothing' edit mode for a single <edit-config> +request. + +R-68990 The xNF **MUST** support the **:startup** capability. It +will allow the running configuration to be copied to this special +database. It can also be locked and unlocked. + +R-68200 The xNF **MUST** support the **:url** value to specify +protocol operation source and target parameters. The capability URI +for this feature will indicate which schemes (e.g., file, https, sftp) +that the server supports within a particular URL value. The 'file' +scheme allows for editable local configuration databases. The other +schemes allow for remote storage of configuration databases. + +R-20353 The xNF **MUST** implement both **:candidate** and +**:writable-running** capabilities. When both **:candidate** and +**:writable-running** are provided then two locks should be supported. -R-54816: The VNF **MUST** support the storage of security audit logs for -agreed period of time for forensic analysis. +R-11499 The xNF **MUST** fully support the XPath 1.0 specification +for filtered retrieval of configuration and other database contents. +The 'type' attribute within the <filter> parameter for <get> and +<get-config> operations may be set to 'xpath'. The 'select' attribute +(which contains the XPath expression) will also be supported by the +server. A server may support partial XPath retrieval filtering, but +it cannot advertise the **:xpath** capability unless the entire XPath +1.0 specification is supported. -R-34957: The VNF **MUST** provide a method of metrics gathering for each -layer's performance to identify/document variances in the allocations so -they can be addressed. +R-83790 The xNF **MUST** implement the **:validate** capability -R-43958: The VNF Package **MUST** include documentation describing the -tests that were conducted by the VNF provider and the test results. +R-49145 The xNF **MUST** implement **:confirmed-commit** If +**:candidate** is supported. -R-61648: The VNF **MUST** support event logging, formats, and delivery -tools to provide the required degree of event data to ONAP +R-58358 The xNF **MUST** implement the **:with-defaults** capability +[RFC6243]. -R-18525: The VNF provider **MUST** provide a JSON file for each supported -action for the VNF. The JSON file must contain key value pairs with all -relevant values populated with sample data that illustrates its usage. The -fields and their description are defined in Appendix A. +R-59610 The xNF **MUST** implement the data model discovery and +download as defined in [RFC6022]. -R-99174: The VNF **MUST** comply with Individual Accountability -(each person must be assigned a unique ID) when persons or non-person -entities access VNFs. +R-87662 The xNF **SHOULD** implement the NETCONF Event Notifications +[RFC5277]. -R-99771: The VNF **MUST** provide all code/configuration files in a -“Locked down” or hardened state or with documented recommendations for -such hardening. All unnecessary services will be disabled. VNF provider -default credentials, community strings and other such artifacts will be -removed or disclosed so that they can be modified or removed during -provisioning. +R-93443 The xNF **MUST** define all data models in YANG [RFC6020], +and the mapping to NETCONF shall follow the rules defined in this RFC. -R-58358: The VNF **MUST** implement the **:with-defaults** -capability [RFC6243]. +R-26115 The xNF **MUST** follow the data model upgrade rules defined +in [RFC6020] section 10. All deviations from section 10 rules shall +be handled by a built-in automatic upgrade mechanism. + +R-10716 The xNF **MUST** support parallel and simultaneous +configuration of separate objects within itself. + +R-29495 The xNF **MUST** support locking if a common object is +being manipulated by two simultaneous NETCONF configuration operations +on the same xNF within the context of the same writable running data +store (e.g., if an interface parameter is being configured then it +should be locked out for configuration by a simultaneous configuration +operation on that same interface parameter). + +R-53015 The xNF **MUST** apply locking based on the sequence of +NETCONF operations, with the first configuration operation locking +out all others until completed. + +R-02616 The xNF **MUST** permit locking at the finest granularity +if a xNF needs to lock an object for configuration to avoid blocking +simultaneous configuration operations on unrelated objects (e.g., BGP +configuration should not be locked out if an interface is being +configured or entire Interface configuration should not be locked out +if a non-overlapping parameter on the interface is being configured). + +R-41829 The xNF **MUST** be able to specify the granularity of the +lock via a restricted or full XPath expression. + +R-66793 The xNF **MUST** guarantee the xNF configuration integrity +for all simultaneous configuration operations (e.g., if a change is +attempted to the BUM filter rate from multiple interfaces on the same +EVC, then they need to be sequenced in the xNF without locking either +configuration method out). + +R-54190 The xNF **MUST** release locks to prevent permanent lock-outs +when/if a session applying the lock is terminated (e.g., SSH session +is terminated). -R-78116: The VNF **MUST** update status on the Chef Server appropriately -(e.g., via a fail or raise an exception) if the chef-client run encounters -any critical errors/failures when executing a VNF action. +R-03465 The xNF **MUST** release locks to prevent permanent lock-outs +when the corresponding <partial-unlock> operation succeeds. -R-84879: The VNF **MUST** have the capability of maintaining a primary and -backup DNS name (URL) for connecting to ONAP collectors, with the ability to -switch between addresses based on conditions defined by policy such as -time-outs, and buffering to store messages until they can be delivered. -At its discretion, the service provider may choose to populate only one -collector address for a VNF. In this case, the network will promptly resolve -connectivity problems caused by a collector or network failure transparently -to the VNF. +R-63935 The xNF **MUST** release locks to prevent permanent lock-outs +when a user configured timer has expired forcing the NETCONF SSH Session +termination (i.e., product must expose a configuration knob for a user +setting of a lock expiration timer) -R-06413: The VNF **MUST** log the field “service or program used for access” -in the security audit logs. +R-10173 The xNF **MUST** allow another NETCONF session to be able to +initiate the release of the lock by killing the session owning the lock, +using the <kill-session> operation to guard against hung NETCONF sessions. -R-51442: The VNF **SHOULD** use playbooks that are designed to automatically -‘rollback’ to the original state in case of any errors for actions that change -state of the VNF (e.g., configure). +R-88899 The xNF **MUST** support simultaneous <commit> operations +within the context of this locking requirements framework. -R-98989: The VNF **SHOULD** utilize resource pooling (threads, connections, -etc.)within the VNF application so that resources are not being created -and destroyed resulting in resource management overhead. +R-07545 The xNF **MUST** support all operations, administration and +management (OAM) functions available from the supplier for xNFs using +the supplied YANG code and associated NETCONF servers. -R-58998: The VNF **MUST** provide or support the Identity and Access Management -(IDAM) based threat detection data for Malware (Key Logger). +R-60656 The xNF **MUST** support sub tree filtering. -R-52499: The VNF **MUST** meet their own resiliency goals and not rely -on the Network Cloud. +R-80898 The xNF **MUST** support heartbeat via a <get> with null filter. -R-43327: The VNF **SHOULD** use “Modeling JSON text with YANG”, -https://trac.tools.ietf.org/id/draft-lhotka-netmod-yang-json-00.html, -If YANG models need to be translated to and from JSON. YANG configuration -and content can be represented via JSON, consistent with Avro, as described -in “Encoding and Serialization” section. +R-06617 The xNF **MUST** support get-schema (ietf-netconf-monitoring) +to pull YANG model over session. -R-52060: The VNF **MUST** provide the capability to configure encryption -algorithms or devices so that they comply with the laws of the jurisdiction -in which there are plans to use data encryption. +R-25238 The xNF PACKAGE **MUST** validated YANG code using the open +source pyang [3]_ program using the following commands: + +R-63953 The xNF **MUST** have the echo command return a zero value +otherwise the validation has failed -R-10353: The VNF **MUST** conform its YANG model to RFC 6244, +R-26508 The xNF **MUST** support NETCONF server that can be +mounted on OpenDaylight (client) and perform the following operations: + +- Modify, update, change, rollback configurations using each + configuration data element. +- Query each state (non-configuration) data element. +- Execute each YANG RPC. +- Receive data through each notification statement. + +R-28545 The xNF **MUST** conform its YANG model to RFC 6060, +“YANG - A Data Modeling Language for the Network Configuration +Protocol (NETCONF)” + +R-29967 The xNF **MUST** conform its YANG model to RFC 6022, +“YANG module for NETCONF monitoring”. + +R-22700 The xNF **MUST** conform its YANG model to RFC 6470, +“NETCONF Base Notifications”. + +R-10353 The xNF **MUST** conform its YANG model to RFC 6244, “An Architecture for Network Management Using NETCONF and YANG”. -R-26586: The VNF **SHOULD** support the ability to work with aliases -(e.g., gateways, proxies) to protect and encapsulate resources. +R-53317 The xNF **MUST** conform its YANG model to RFC 6087, +“Guidelines for Authors and Reviewers of YANG Data Model Documents”. -R-14025: The VNF **MUST** provide or support the Identity and Access -Management (IDAM) based threat detection data for Session Hijacking. +R-33955 The xNF **SHOULD** conform its YANG model to RFC 6991, +“Common YANG Data Types”. + +R-22946 The xNF **SHOULD** conform its YANG model to RFC 6536, +“NETCONF Access Control Model”. + +R-10129 The xNF **SHOULD** conform its YANG model to RFC 7223, +“A YANG Data Model for Interface Management”. + +R-12271 The xNF **SHOULD** conform its YANG model to RFC 7223, +“IANA Interface Type YANG Module”. + +R-49036 The xNF **SHOULD** conform its YANG model to RFC 7277, +“A YANG Data Model for IP Management”. + +R-87564 The xNF **SHOULD** conform its YANG model to RFC 7317, +“A YANG Data Model for System Management”. + +R-24269 The xNF **SHOULD** conform its YANG model to RFC 7407, +“A YANG Data Model for SNMP Configuration”. -R-86835: The VNF **MUST** set the default settings for user access to -sensitive commands and data to deny authorization. - -R-73583: The VNF **MUST** allow changes of configuration parameters to be -consumed by the VNF without requiring the VNF or its sub-components to be -bounced so that the VNF availability is not effected. - -R-73223: The VNF **MUST** support proactive monitoring to detect and report -the attacks on resources so that the VNFs and associated VMs can be isolated, -such as detection techniques for resource exhaustion, namely OS resource -attacks, CPU attacks, consumption of kernel memory, local storage attacks. - -R-06668: The VNF **MUST** handle the start or restart of VNFC instances in -any order with each VNFC instance establishing or re-establishing required -connections or relationships with other VNFC instances and/or VNFs required -to perform the VNF function/role without requiring VNFC instance(s) to be -started/restarted in a particular order. - -R-41215: The VNF **MAY** have zero to many “incremental” modules. - -R-85991: The VNF provider **MUST** provide a universal license key per VNF to -be used as needed by services (i.e., not tied to a VM instance) as the -recommended solution. The VNF provider may provide pools of Unique VNF -License Keys, where there is a unique key for each VNF instance as an -alternate solution. Licensing issues should be resolved without interrupting -in-service VNFs. - -R-52085: The VNF **MUST**, if not using the NCSP’s IDAM API, provide the -ability to support Multi-Factor Authentication (e.g., 1st factor = Software -token on device (RSA SecureID); 2nd factor = User Name+Password, etc.) -for the users. - -R-29495: The VNF **MUST** support locking if a common object is being -manipulated by two simultaneous NETCONF configuration operations on the -same VNF within the context of the same writable running data store -(e.g., if an interface parameter is being configured then it should be -locked out for configuration by a simultaneous configuration operation -on that same interface parameter). - -R-31751: The VNF **MUST** subject VNF provider VNF access to privilege -reconciliation tools to prevent access creep and ensure correct enforcement -of access policies. - -R-48698: The VNF **MUST** utilize information from key value pairs that -will be provided by the Ansible Server as extra-vars during invocation -to execute the desired VNF action. If the playbook requires files, -they must also be supplied using the methodology detailed in the -Ansible Server API. - -R-44290: The VNF **MUST** control access to ONAP and to VNFs, and creation of -connections, through secure credentials, log-on and exchange mechanisms. - -R-40293: The VNF **MUST** make available (or load on VNF Ansible Server) -playbooks that conform to the ONAP requirement. - -R-30932: The VNF **MUST** provide security audit logs including records of -successful and rejected system access data and other resource access attempts. - -R-12538: The VNF **SHOULD** support load balancing and discovery mechanisms -in resource pools containing VNFC instances. - -R-59610: The VNF **MUST** implement the data model discovery and download -as defined in [RFC6022]. - -R-49945: The VNF **MUST** authorize VNF provider access through a -client application API by the client application owner and the -resource owner of the VNF before provisioning authorization through -Role Based Access Control (RBAC), Attribute Based Access Control (ABAC), -or other policy based mechanism. - -R-20912: The VNF **MUST** support alternative monitoring capabilities -when VNFs do not expose data or control traffic or use proprietary -and optimized protocols for inter VNF communication. +R-33946 The xNF **MUST** conform to the NETCONF RFC 4741, +“NETCONF Configuration Protocol”. + +R-04158 The xNF **MUST** conform to the NETCONF RFC 4742, +“Using the NETCONF Configuration Protocol over Secure Shell (SSH)”. + +R-13800 The xNF **MUST** conform to the NETCONF RFC 5277, +“NETCONF Event Notification”. + +R-01334 The xNF **MUST** conform to the NETCONF RFC 5717, +“Partial Lock Remote Procedure Call”. + +R-08134 The xNF **MUST** conform to the NETCONF RFC 6241, +“NETCONF Configuration Protocol”. + +R-78282 The xNF **MUST** conform to the NETCONF RFC 6242, +“Using the Network Configuration Protocol over Secure Shell”. + +R-31809 The xNF **MUST** support the HealthCheck RPC. The HealthCheck +RPC executes a xNF Provider-defined xNF HealthCheck over the scope of +the entire xNF (e.g., if there are multiple VNFCs, then run a health check, +as appropriate, for all VNFCs). It returns a 200 OK if the test completes. +A JSON object is returned indicating state (healthy, unhealthy), scope +identifier, time-stamp and one or more blocks containing info and fault +information. If the xNF is unable to run the HealthCheck, return a +standard http error code and message. + +R-79224 The xNF **MUST** have the chef-client be preloaded with +validator keys and configuration to register with the designated +Chef Server as part of the installation process. + +R-72184 The xNF **MUST** have routable FQDNs for all the endpoints +(VMs) of a xNF that contain chef-clients which are used to register +with the Chef Server. As part of invoking xNF actions, ONAP will +trigger push jobs against FQDNs of endpoints for a xNF, if required. + +R-47068 The xNF **MAY** expose a single endpoint that is +responsible for all functionality. + +R-67114 The xNF **MUST** be installed with: + +- Chef-Client >= 12.0 +- Chef push jobs client >= 2.0 + +R-27310 The xNF Package **MUST** include all relevant Chef artifacts +(roles/cookbooks/recipes) required to execute xNF actions requested by +ONAP for loading on appropriate Chef Server. + +R-26567 The xNF Package **MUST** include a run list of +roles/cookbooks/recipes, for each supported xNF action, that will +perform the desired xNF action in its entirety as specified by ONAP +(see Section 7.c, ONAP Controller APIs and Behavior, for list of xNF +actions and requirements), when triggered by a chef-client run list +in JSON file. + +R-98911 The xNF **MUST NOT** use any instance specific parameters +for the xNF in roles/cookbooks/recipes invoked for a xNF action. + +R-37929 The xNF **MUST** accept all necessary instance specific +data from the environment or node object attributes for the xNF +in roles/cookbooks/recipes invoked for a xNF action. + +R-62170 The xNF **MUST** over-ride any default values for +configurable parameters that can be set by ONAP in the roles, +cookbooks and recipes. + +R-78116 The xNF **MUST** update status on the Chef Server +appropriately (e.g., via a fail or raise an exception) if the +chef-client run encounters any critical errors/failures when +executing a xNF action. + +R-44013 The xNF **MUST** populate an attribute, defined as node +[‘PushJobOutput’] with the desired output on all nodes in the push job +that execute chef-client run if the xNF action requires the output of a +chef-client run be made available (e.g., get running configuration). + +R-30654 The xNF Package **MUST** have appropriate cookbooks that are +designed to automatically ‘rollback’ to the original state in case of +any errors for actions that change state of the xNF (e.g., configure). + +R-65755 The xNF **SHOULD** support callback URLs to return information +to ONAP upon completion of the chef-client run for any chef-client run +associated with a xNF action. + +- As part of the push job, ONAP will provide two parameters in the + environment of the push job JSON object: + + - ‘RequestId’ a unique Id to be used to identify the request, + - ‘CallbackUrl’, the URL to post response back. + +- If the CallbackUrl field is empty or missing in the push job, then + the chef-client run need not post the results back via callback. + +R-15885 The xNF **MUST** Upon completion of the chef-client run, +POST back on the callback URL, a JSON object as described in Table +A2 if the chef-client run list includes a cookbook/recipe that is +callback capable. Failure to POST on the Callback Url should not be +considered a critical error. That is, if the chef-client successfully +completes the xNF action, it should reflect this status on the Chef +Server regardless of whether the Callback succeeded or not. + +R-32217 The xNF **MUST** have routable FQDNs that are reachable via +the Ansible Server for the endpoints (VMs) of a xNF on which playbooks +will be executed. ONAP will initiate requests to the Ansible Server +for invocation of playbooks against these end points [4]_. + +R-54373 The xNF **MUST** have Python >= 2.6 on the endpoint VM(s) +of a xNF on which an Ansible playbook will be executed. + +R-35401 The xNF **MUST** support SSH and allow SSH access by the +Ansible server for the endpoint VM(s) and comply with the Network +Cloud Service Provider guidelines for authentication and access. + +R-82018 The VNF **MUST** load the Ansible Server SSH public key onto VNF +VM(s) as part of instantiation. This will allow the Ansible Server +to authenticate to perform post-instantiation configuration without +manual intervention and without requiring specific VNF login IDs and +passwords. + +R-92866 The VNF **MUST** include as part of post-instantiation +configuration done by Ansible Playbooks the removal/update of SSH +public keys loaded through instantiation to support Ansible. This may +include download and install of new SSH public keys. + +R-91745 The VNF **MUST** update the Ansible Server and other entities +storing and using the SSH keys for authentication when the SSH keys used +by Ansible are regenerated/updated. + +R-40293 The xNF **MUST** make available playbooks that conform +to the ONAP requirement. + +R-49396 The xNF **MUST** support each ONAP (APPC) xNF action by +invocation of **one** playbook [7]_. The playbook will be responsible +for executing all necessary tasks (as well as calling other playbooks) +to complete the request. + +R-33280 The xNF **MUST NOT** use any instance specific parameters +in a playbook. + +R-48698 The xNF **MUST** utilize information from key value pairs +that will be provided by the Ansible Server as "extra-vars" during +invocation to execute the desired xNF action. If the playbook requires +files, they must also be supplied using the methodology detailed in +the Ansible Server API, unless they are bundled with playbooks, example, +generic templates. + +R-43253 The xNF **MUST** use playbooks designed to allow Ansible +Server to infer failure or success based on the “PLAY_RECAP” capability. +NOTE: There are cases where playbooks need to interpret results of a task +and then determine success or failure and return result accordingly +(failure for failed tasks). + +R-50252 The xNF **MUST** write to a specific one text files that +will be retrieved and made available by the Ansible Server if, as part +of a xNF action (e.g., audit), a playbook is required to return any +xNF information. The text files must be written in the same directory as +the one from which the playbook is being executed. A text file must be +created for the xNF playbook run targets/affects, with the name +‘<VNFname>_results.txt’ into which any desired output from each +respective VM/xNF must be written. + +R-51442 The xNF **SHOULD** use playbooks that are designed to +automatically ‘rollback’ to the original state in case of any errors +for actions that change state of the xNF (e.g., configure). + +R-58301 The VNF **SHOULD NOT** use playbooks that make requests to +Cloud resources e.g. Openstack (nova, neutron, glance, heat, etc.); +therefore, there is no use for Cloud specific variables like Openstack +UUIDs in Ansible Playbooks. + +R-02651 The VNF **SHOULD** use the Ansible backup feature to save a +copy of configuration files before implementing changes to support +operations such as backing out of software upgrades, configuration +changes or other work as this will help backing out of configuration +changes when needed. + +R-43353 The VNF **MUST** return control from Ansible Playbooks only +after tasks are fully complete, signaling that the playbook completed +all tasks. When starting services, return control only after all services +are up. This is critical for workflows where the next steps are dependent + +R-51910 The xNF **MUST** provide all telemetry (e.g., fault event +records, syslog records, performance records etc.) to ONAP using the +model, format and mechanisms described in this section. + +R-19624 The xNF **MUST** encode and serialize content delivered to +ONAP using JSON (RFC 7159) plain text format. High-volume data is to +be encoded and serialized using `Avro <http://avro.apache.org/>`_, +where the Avro [6]_ data format are described using JSON. + +- JSON plain text format is preferred for moderate volume data sets + (option 1), as JSON has the advantage of having well-understood simple + processing and being human-readable without additional decoding. Examples + of moderate volume data sets include the fault alarms and performance + alerts, heartbeat messages, measurements used for xNF scaling and syslogs. +- Binary format using Avro is preferred for high volume data sets + (option 2) such as mobility flow measurements and other high-volume + streaming events (such as mobility signaling events or SIP signaling) + or bulk data, as this will significantly reduce the volume of data + to be transmitted. As of the date of this document, all events are + reported using plain text JSON and REST. +- Avro content is self-documented, using a JSON schema. The JSON schema is + delivered along with the data content + (http://avro.apache.org/docs/current/ ). This means the presence and + position of data fields can be recognized automatically, as well as the + data format, definition and other attributes. Avro content can be + serialized as JSON tagged text or as binary. In binary format, the + JSON schema is included as a separate data block, so the content is + not tagged, further compressing the volume. For streaming data, Avro + will read the schema when the stream is established and apply the + schema to the received content. + +R-98191 The xNF **MUST** vary the frequency that asynchronous data +is delivered based on the content and how data may be aggregated or +grouped together. For example, alarms and alerts are expected to be +delivered as soon as they appear. In contrast, other content, such as +performance measurements, KPIs or reported network signaling may have +various ways of packaging and delivering content. Some content should +be streamed immediately; or content may be monitored over a time interval, +then packaged as collection of records and delivered as block; or data +may be collected until a package of a certain size has been collected; +or content may be summarized statistically over a time interval, or +computed as a KPI, with the summary or KPI being delivered. + +- We expect the reporting frequency to be configurable depending + on the virtual network function’s needs for management. For example, + Service Provider may choose to vary the frequency of collection between + normal and trouble-shooting scenarios. +- Decisions about the frequency of data reporting will affect the + size of delivered data sets, recommended delivery method, and how the + data will be interpreted by ONAP. These considerations should not + affect deserialization and decoding of the data, which will be guided + by the accompanying JSON schema or GPB definition files. + +R-88482 The xNF **SHOULD** use REST using HTTPS delivery of plain +text JSON for moderate sized asynchronous data sets, and for high +volume data sets when feasible. + +R-84879 The xNF **MUST** have the capability of maintaining a primary +and backup DNS name (URL) for connecting to ONAP collectors, with the +ability to switch between addresses based on conditions defined by policy +such as time-outs, and buffering to store messages until they can be +delivered. At its discretion, the service provider may choose to populate +only one collector address for a xNF. In this case, the network will +promptly resolve connectivity problems caused by a collector or network +failure transparently to the xNF. + +R-81777 The VNF **MUST** be configured with initial address(es) to use +at deployment time. Subsequently, address(es) may be changed through +ONAP-defined policies delivered from ONAP to the VNF using PUTs to a +RESTful API, in the same manner that other controls over data reporting +will be controlled by policy. + +R-08312 The xNF **MAY** use other options which are expected to include + +- REST delivery of binary encoded data sets. +- TCP for high volume streaming asynchronous data sets and for other + high volume data sets. TCP delivery can be used for either + JSON or binary encoded data sets. +- SFTP for asynchronous bulk files, such as bulk files that contain + large volumes of data collected over a long time interval or data + collected across many xNFs. This is not preferred. Preferred is to + reorganize the data into more frequent or more focused data sets, and + deliver these by REST or TCP as appropriate. +- REST for synchronous data, using RESTCONF (e.g., for xNF state polling). + +R-03070 The xNF **MUST**, by ONAP Policy, provide the ONAP addresses +as data destinations for each xNF, and may be changed by Policy while +the xNF is in operation. We expect the xNF to be capable of redirecting +traffic to changed destinations with no loss of data, for example from +one REST URL to another, or from one TCP host and port to another. + +R-06924 The xNF **MUST** deliver asynchronous data as data becomes +available, or according to the configured frequency. + +R-73285 The xNF **MUST** must encode, address and deliver the data +as described in the previous paragraphs. + +R-42140 The xNF **MUST** respond to data requests from ONAP as soon +as those requests are received, as a synchronous response. + +R-34660 The xNF **MUST** use the RESTCONF/NETCONF framework used by +the ONAP configuration subsystem for synchronous communication. + +R-86586 The VNF **MUST** use the YANG configuration models and RESTCONF +[RFC8040] (https://tools.ietf.org/html/rfc8040). + +R-11240 The xNF **MUST** respond with content encoded in JSON, as +described in the RESTCONF specification. This way the encoding of a +synchronous communication will be consistent with Avro. + +R-70266 The xNF **MUST** respond to an ONAP request to deliver the +current data for any of the record types defined in +Event Records - Data Structure Description by returning the requested +record, populated with the current field values. (Currently the defined +record types include fault fields, mobile flow fields, measurements for +xNF scaling fields, and syslog fields. Other record types will be added +in the future as they become standardized and are made available.) + +R-46290 The xNF **MUST** respond to an ONAP request to deliver granular +data on device or subsystem status or performance, referencing the YANG +configuration model for the xNF by returning the requested data elements. + +R-43327 The xNF **SHOULD** use `Modeling JSON text with YANG +<https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be +translated to and from JSON[RFC7951]. YANG configuration and content can +be represented via JSON, consistent with Avro, as described in “Encoding +and Serialization” section. + +R-42366 The xNF **MUST** support secure connections and transports such as +Transport Layer Security (TLS) protocol +[`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to +the best current practices outlined in +`RFC7525 <https://tools.ietf.org/html/rfc7525>`_. + +R-44290 The xNF **MUST** control access to ONAP and to xNFs, and creation +of connections, through secure credentials, log-on and exchange mechanisms. + +R-47597 The xNF **MUST** carry data in motion only over secure connections. + +R-68165 The xNF **MUST** encrypt any content containing Sensitive Personal +Information (SPI) or certain proprietary data, in addition to applying the +regular procedures for securing access and delivery. Ansible Playbook Examples |