Update VNFRQTS-572
[vnfrqts/requirements.git] / docs / Chapter5 / Tosca.rst
index ec664d2..be24fcd 100644 (file)
@@ -214,20 +214,23 @@ VNF Package Contents
 
 .. req::
     :id: R-146092
 
 .. req::
     :id: R-146092
-    :target: VNF or PNF
+    :target: VNF or PNF TOSCA PACKAGE
     :keyword: MUST
     :introduced: dublin
     :keyword: MUST
     :introduced: dublin
-    
-    The VNF or PNF package Manifest file **MUST** contain: non-mano artifact
-    set with following ONAP public tag:
 
 
-      - onap_ves_events
+    The VNF or PNF TOSCA CSAR package Manifest file **MUST** contain: non-mano
+    artifact set with following ONAP public tag
+
+      - onap_ves_events: contains VES registration files
 
 
-      - onap_pm_dictionary
+      - onap_pm_dictionary: contains the PM dictionary files
 
 
-      - onap_yang_module
+      - onap_yang_modules: contains Yang module files for configurations
 
 
-      - onap_others
+      - onap_ansible_playbooks: contains any ansible_playbooks
+
+      - onap_others: contains any other non_MANO artifacts, e.g. informational
+        documents
 
 .. req::
     :id: R-221914
 
 .. req::
     :id: R-221914
@@ -242,7 +245,7 @@ VNF Package Contents
 
 .. req::
     :id: R-57019
 
 .. req::
     :id: R-57019
-    :target: PNF CSAR PACKAGE  
+    :target: PNF CSAR PACKAGE
     :keyword: MUST
     :introduced: dublin
 
     :keyword: MUST
     :introduced: dublin
 
@@ -258,23 +261,90 @@ VNF Package Contents
 
       - pnfd_archive_version
 
 
       - pnfd_archive_version
 
-VNF or PNF Package Authenticity
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. req::
+    :id: R-795126
+    :target: VNF CSAR PACKAGE
+    :keyword: MUST
+    :introduced: dublin
+
+    The VNF TOSCA CSAR package Manifest file **MUST** start with the VNF
+    package metadata in the form of a name-value pairs. Each pair shall appear
+    on a different line. The name is specified as following:
+
+      - vnf_provider_id
+
+      - vnf_product_name
+
+      - vnf_release_date_time
+
+      - vnf_package_version
+
+
+VNF or PNF Package Authenticity and Integrity
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+VNF or PNF CSAR package shall support a method for authenticity and integrity
+assurance. According to ETSI SOL004 the onboarding package shall be secured.
+ETSI SOL004 provides two options:
+
+Option 1 - One Digest for each components of the VNF or PNF package. The table
+of hashes is included in the manifest file, which is signed with the VNF or PNF
+provider private key. A signing certificate including the provider’s public key
+shall be included in the package.
 
 
-VNF or PNF package shall support a method for authenticity and integrity
-assurance. Note, Option 2 specified in SOL004 is supported in Dublin release.
+Option 2 - The complete CSAR file shall be digitally signed with the provider
+private key. The provider delivers one zip file consisting of the CSAR file, a
+signature file and a certificate file that includes the VNF provider public
+key.
+
+*Dublin release note*
+
+    - VNFSDK pre-onboarding validation procedure:
+
+      - Option 1: specified in ETSI SOL004 is supported.
+
+      - Option 2: Will be supported in the future releases.
+
+    - SDC onboarding procedure:
+
+      - Option 1: specified in ETSI SOL004 is supported.
+
+      - Option 2: Will be supported in the future releases.
 
 .. req::
 
 .. req::
-    :id: R-444945
-    :target: VNF or PNF
+    :id: R-787965
+    :target: VNF or PNF CSAR PACKAGE
     :keyword: MUST
     :introduced: dublin
 
     :keyword: MUST
     :introduced: dublin
 
-    The complete CSAR file **MUST** be digitally signed with the VNF or PNF
+    If the VNF or PNF CSAR Package utilizes Option 2 for package security, then
+    the complete CSAR file **MUST** be digitally signed with the VNF or PNF
     provider private key. The VNF or PNF provider delivers one zip file
     consisting of the CSAR file, a signature file and a certificate file that
     includes the VNF or PNF provider public key. The certificate may also be
     provider private key. The VNF or PNF provider delivers one zip file
     consisting of the CSAR file, a signature file and a certificate file that
     includes the VNF or PNF provider public key. The certificate may also be
-    included in the signaturecontainer, if the signature format allows that.
+    included in the signature container, if the signature format allows that.
+    The VNF or PNF provider creates a zip file consisting of the CSAR file with
+    .csar extension, signature and certificate files. The signature and
+    certificate files must be siblings of the CSAR file with extensions .cms
+    and .cert respectively.
+
+
+.. req::
+    :id: R-130206
+    :target: VNF or PNF CSAR PACKAGE
+    :keyword: MUST
+    :introduced: dublin
+
+    If the VNF or PNF CSAR Package utilizes Option 2 for package security, then
+    the complete CSAR file **MUST** contain a Digest (a.k.a. hash) for each of
+    the components of the VNF or PNF package. The table of hashes is included
+    in the package manifest file, which is signed with the VNF or PNF provider
+    private key. In addition, the VNF or PNF provider MUST include a signing
+    certificate that includes the VNF or PNF provider public key, following a
+    TOSCA pre-defined naming convention and located either at the root of the
+    archive or in a predefined location specified by the TOSCA.meta file with
+    the corresponding entry named "ETSI-Entry-Certificate".
+
 
 VNF Package ONAP Extensions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 VNF Package ONAP Extensions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~