Add security notes 89/139589/1
authoradheli.tavares <adheli.tavares@est.tech>
Thu, 28 Nov 2024 09:56:08 +0000 (09:56 +0000)
committeradheli.tavares <adheli.tavares@est.tech>
Thu, 28 Nov 2024 10:14:33 +0000 (10:14 +0000)
- threat modeling
- ensure user knows which environment is production and which is
for testing only.

Issue-ID: POLICY-4817
Change-Id: I893ff875b9e812ba8b91bc15cd4f1df737800e8b
Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
docs/architecture/architecture.rst
docs/development/devtools/testing/csit.rst

index fb960f0..18f2d23 100644 (file)
@@ -769,5 +769,26 @@ Policy Set                        A set of policies that are deployed on a PDP g
                                   deployed on a PDP group
 ================================= ==================================================================================
 
+5. Security
+===========
+
+5.1 Threat Modeling
+-------------------
+
+====================== ==================================================== ==========================
+Threat category        Attacker’s motive                                    Affected security property
+====================== ==================================================== ==========================
+Spoofing               Impersonating another user or system                 Authenticity
+Tampering              Illegal modification of data in transit or at rest   Integrity
+Repudiation            Disputing an action that has taken place             Non-repudiability
+Information            Disclosure of confidential information               Confidentiality
+Denial of Service      Making system temporarily or permanently unavailable Availability
+Elevation of Privilege Gaining higher privileges than entitled to           Authority
+====================== ==================================================== ==========================
+
+To ensure that this threat model is mitigated, use only ONAP Operations Manager `OOM <https://github.com/onap/oom>`_
+for production deployment. Policy docker and helm environment available at `policy-docker <https://github.com/onap/policy-docker>`_
+are for testing purposes only.
+
 
 End of Document
index 4eb1256..ede88af 100644 (file)
@@ -16,6 +16,10 @@ that common usage of Policy Framework services are running as expected.
 This article provides the steps to run CSIT tests in a local environment, most commonly after a
 significant code change.
 
+.. note::
+  Both environments described in this page are for test or learning purposes only. For real deployment
+  environment, use `ONAP Operations Manager <https://github.com/onap/oom>`_
+
 .. note::
   If building images locally, follow the instructions :ref:`here <building-pf-docker-images-label>`
 
@@ -43,40 +47,13 @@ If not familiar with the PF Docker structure, the detailed information can be fo
 Running tests to validate code changes
 --------------------------------------
 
-After building image(s) locally, the compose file needs to be edited to use the local image when
-bringing up the container. Open file `~/git/policy/docker/compose/docker-compose.yml` and remove the
-tag `${CONTAINER_LOCATION}` from the image variable in the service description.
-If change is GUI related, then `docker-compose.gui.yml` might need to be edited as well, although
-there are no GUI related test suites.
-
-For example, if testing against a PAP change, a new onap/policy-pap image with latest and
-x.y.z-SNAPSHOT versions is available. When editing the docker-compose file, the following change
-would be done:
-
-From:
-
-.. code-block:: yaml
-
-  pap:
-  image: ${CONTAINER_LOCATION}onap/policy-pap:${POLICY_PAP_VERSION}
-  container_name: policy-pap
-
-
-To:
-
-.. code-block:: yaml
-
-  pap:
-  image: onap/policy-pap:latest
-  container_name: policy-pap
-
+For *local* images, set `LOCAL_IMAGES=true`, located at the `get-versions.sh` script
 
 .. note::
    Make sure to do the same changes to any other components that are using locally built images.
 
 
-After finished with edits in compose file, then use the `run-project-csit.sh` script to run the
-test suite.
+Then use the `run-project-csit.sh` script to run the test suite.
 
 
 .. code-block:: bash
@@ -94,7 +71,7 @@ The <component> input is any of the policy components available:
  - drools-pdp
  - drools-applications
  - xacml-pdp
- - policy-acm-runtime
+ - clamp
 
 Keep in mind that after the Robot executions, logs from docker-compose are printed and
 test logs might not be available on console and the containers are teared down. The tests results