PF - ONAP Security Review Questionnaire

Owned by Adheli Tavares
Last updated: Sept 05, 2023
16 min read

"The project MUST have performed a security review within the last 5 years. This review MUST consider the security requirements and security boundary." – Best Practices Badging Criterion


Please fill in the survey questions for each of the following sections. In all cases, answer the questions from the point of view for YOUR application within ONAP.

For each one, additional information on the question is available to be read by clicking the arrow following the question.

Most items in this questionnaire are related to specific Best Practices Badging Criteria. The name of the associated criterion is listed at the end of the toggled "additional information" section, along with an indication of the badging level of the question, P=passing, S=silver and G=gold.


Once the security review is completed, the application owner can update the gold level badging question "security-review" as having been accomplished.


POLICY-4681 - Getting issue details... STATUS


Follow up Jira for documentation - POLICY-4817 - Getting issue details... STATUS

Security Knowledge

Know Secure Design

Do the committers and PTL know how to design secure software? Do the reviewers of OJSI tickets know secure design?

Your Answers-Please ExplainSECCOM Feedback / Recommendations
Yes - the PF team follows the best common practices regarding security and possible vulnerabilities✅

Implement Secure Design

Do the committers and PTL apply secure design principles when reviewing software for merging?

Your Answer-Please ExplainSECCOM Feedback / Recommendations
Yes - the PF team/PTL/committers review and look for security issues and recommend fixes before merging.

?

  • does the team fix the findings identified by SonarCloud and NexusIQ? 
    • depends on how the fix needs to be implemented. some of the current issues require dependency updates that would break code and are part of the java-17 upgrade.

Know Common Errors

Do the committers and PTL understand commonly found errors (and how to counter or mitigate them)? Do they apply these principles when reviewing software for merging?

Your Answers-Please ExplainSECCOM Feedback / Recommendations
Yes - the PF team & PTL are aware of common security risks and how to mitigate them✅

No Leaked Credentials

Do the committers and PTL verify that there are no non-test credentials and no non-test private keys in code to be merged?

Your Answer-Please ExplainSECCOM Feedback / Recommendations

We have public user/password in configuration files, including test files. It's recommended to change it and most of the non-test usage is done with helm charts, which generate secrets.

✅

Security Documentation

Documentation Architecture

Does your project have an architecture or high level design documented?

If so, please provide a URL to the pages on wiki.onap.org or onap.readthedocs.io that have the architecture or high level design. If not, please describe the high level design here using one or more paragraphs.

Your Answer-Please DescribeSECCOM Feedback / Recommendations

ONAP documentation - https://docs.onap.org/projects/onap-policy-parent/en/latest/index.html

✅

Documentation Security

Does your project have a description of what a user of your project can and cannot expect in terms of security from the software produced by the project, (In other words, what are its 'security requirements'?)

If so, please provide a URL to the page(s) on wiki.onap.org or onap.readthedocs.io. If not, please describe the security requirements here using one or more paragraphs.

Your Answer-Please DescribeSECCOM Feedback / Recommendations

All the resources that can be accessed in PF require authentication

❌

  • Please submit link with your security documentation + information about what capabilities authentication provides.
  • Do you require authorization? No
  • Can PF restrict access to resources based on identity? if so what mechanisms are used? No
  • Are there different levels of authorization once you've authenticated? No
  • Is there authentication and authorization on the events being acted? Authentication only
  • What kind of security is used to control access to the network elements being controlled? PF is using service mesh
  • 2023/8/22: PF will create Montreal Jira ticket to document security architecture and assurance.

Assurance Case

Does your project actually meet its documented security requirements?

If so, please provide a URL to the page(s) on wiki.onap.org or onap.readthedocs.io that describe how the project meets its security goals. If not, please describe here (using one or more paragraphs) how the project meets its security goals.

Your Answer-Please DescribeSECCOM Feedback / Recommendations

Test cases are found at https://github.com/onap/policy-docker/tree/master/csit/resources/tests showing that authentication must be done before interacting with any resource.

ONAP docs describring how to run test cases https://docs.onap.org/projects/onap-policy-parent/en/latest/development/devtools/testing/csit.html

?

Good start

  • answer questions above under documentation security,
  • create Wiki page for your Assurance Case (or a section on the Documentation Security page)
  • provide answers there.
  • In particular describe how your security goals are being met by your implementation, or not
  • provide here a link to that Wiki page/section
  • 2023/8/22: PF will create Montreal Jira ticket to document security architecture and assurance.

Vulnerability Mitigation

Vulnerabilities Critical Fixed

Have you closed all issues filed against your project in sonarcloud that are CRITICAL or BLOCKERs?

Your Answer-Please ExplainSECCOM Feedback / Recommendations

Sonarcloud reports can be found at:

https://sonarcloud.io/project/overview?id=onap_policy-apex-pdp

https://sonarcloud.io/project/overview?id=onap_policy-api

https://sonarcloud.io/project/overview?id=onap_policy-clamp

https://sonarcloud.io/project/overview?id=onap_policy-common

https://sonarcloud.io/project/overview?id=onap_policy-distribution

https://sonarcloud.io/project/overview?id=onap_policy-drools-applications

https://sonarcloud.io/project/overview?id=onap_policy-drools-pdp

https://sonarcloud.io/project/overview?id=onap_policy-gui

https://sonarcloud.io/project/overview?id=onap_policy-models

https://sonarcloud.io/project/overview?id=onap_policy-pap

https://sonarcloud.io/project/overview?id=onap_policy-xacml-pdp

❌

The following have security hotspots

policy-common, policy-pap

The latter is a high priority item that is >1 year old.

  • they mentioned security hotspot is a piece of code necessary for ingestion in another private service - it would change both implementations for token exchange, which is not in question.
  • 2023/8/22: PF review the hotspot in policy-common and policy-pap to determine if they are false positives.
  • 2023/8/22: SECCOM will investigate disabling false positives in sonarcloud.



Vulnerabilities Fixed 60 Days

Are all vulnerabilities that are reported against your project, either through an OJSI ticket or publicly from CVE reports, fixed within two months of being reported?

Your Answer-Please ExplainSECCOM Feedback / Recommendations

We try to keep up to date on fixing vulnerabilities reported on IQ Nexus, except when dependency updates break the current code and a study is necessary to mitigate functionalities not working.

?

And sonar cloud?

  • sonar cloud is also checked, the team has sonar cloud configured with IDEs.

policy-pap has a high severity security item reported in sonarcloud for >1 year

  • see answer above.


How are OJSIs dealt with?

  • 2023/8/22: PF will document response process for unplanned security issues that have to be fixed outside of the normal release cycle.


Non-Cryptographic Software Questions

The following are a few issues regarding your project's software as delivered that are not cryptographic-related.

Input Validation

Does your application accept input from potentially untrusted sources? If so, do you ensure that the input is valid before processing it?

Your Answer-Please ExplainSECCOM Feedback / Recommendations

BeanValidation is used for any request coming in, checking if format and type rules are matched.


✅

Hardening

Does your project apply hardening mechanisms so that software defects are less likely to result in security vulnerabilities?

Your Answer-Please ExplainSECCOM Feedback / Recommendations

No UI

No encryption, as data processed by PF hasn't been tagged as sensitive.

The application uses Swagger for RESTful API, wherein it is set that Authorization headers are required for accessing API documentation.

When PF runs with docker, the services use usernames and passwords that are stored as environment variables.

For helm deployments PF uses K8s secrets which are generated and stored as the application is deployed.

The user has the option to provide a username/password to the helm chart - in this case a kubernetes secret

will be generated by the chart and used for authentication. Alternatively, the user can provide a secret to the chart values - in this case, no secret

will be generated - the chart will just use the k8s secret provided by the user/deployer

?

  • Is https used? - no
  • Has the project migrated to the service mesh which provides https and RBAC - yes
  • 2023/8/22: document security controls provided by service mesh and K8S: encryption in transit, authentication (policy enforcement, policy decision, and policy information point). PF designed to run in K8S with a service mesh providing security controls.


Cryptographic-specific Software Questions

The following questions all deal with cryptographic issues.

Crypto Call – Generic

Does your software implement any cryptographic functions, such as hash functions, instead of calling on software specifically designed to implement cryptographic functions?

Your Answer-Please ExplainSECCOM Feedback / Recommendations
N/A✅

Crypto Random - Generic

Does your software use random information? If so, does it use a cryptographically secure random number generator?

Your Answers-Please ExplainSECCOM Feedback / Recommendations

UUID random keys

  • using java native way of generation java.util.UUID

✅

Crypto Weaknesses

Does your software depend on any cryptographic algorithms or modes that have known serious weaknesses?

Your Answer-Please ExplainSECCOM Feedback / Recommendations

Depends of user managing crypto their own passwords - passwords are configurable in application.yaml for Spring applications (api, pap and acm) and .json configuration files for others. The credentials provided in these files are used for authentication (no authorization dealt in any of PF components) to use any of the REST APIs provided by PF.

All of the authorization/authentication is being managed by service mesh - using the authorizationPolicy implemented into SM.

? 2023/8/22: move information in "Your Answer" to the security documentation.

Please expand on the use of configurable usernames+passwords and what they allow.

2023/8/22: add password use and protection to security documentation. Determine if spring is doing authentication, authorization or both. If PF is storing passwords in order to call APIs, document the secure storage and access of the passwords.

2023/8/22: cryptography provided by K8S using secure algorithms and ciphers.

Crypto Working

Does your software depend on any cryptographic algorithms that are known to be broken?

Your Answer-Please ExplainSECCOM Feedback / Recommendations

UUID generator is being used, but for IDs, not for security concerns.

No crypto being used.

❌

Doesn't answer the question

2023/8/22: PF to document all uses of cryptographic algorithms within the PF application. UUID generation is not part of cryptography.

Crypto Keylength

Does your software generate any keys? If so, do they use any default key-lengths that are considered insecure?

Your Answers-Please ExplainSECCOM Feedback / Recommendations

No keys being generated for us in OOM, PF is part of service mesh to connect to other services.

UUID generated (using java native way) are for identifiers.

✅

Doesn't answer the question

Crypto Algorithm Agility

Does your software use cryptographic algorithms? If so, can a user of ONAP switch the algorithm if one is found to be broken?

Your Answers-Please ExplainSECCOM Feedback / Recommendations

No crypto is being used, aside from UUID generated (using java native way), which are used for identifiers.

❌

Doesn't answer the question

Crypto Certificate Verification

Does your software use HTTPS? If so, does it do certificate verification of the host certificates by default?

Your Answers-Please ExplainSECCOM Feedback / Recommendations

PF is compliant and compatible with the ongoing service mesh implementation (https://gerrit.onap.org/r/c/oom/+/128543) for ONAP. 

✅

Crypto Credential Agility

Does your software save or process authentication credentials or private cryptographic keys? If so, is that information stored separately from other information?

Your Answers-Please ExplainSECCOM Feedback / Recommendations

Credentials are managed by k8s secrets.

❌

Doesn't answer the question

Crypto TLS1.2

Does your software support HTTPS? If so, is the minimum version allowed TLS1.2?

Your Answers-Please ExplainSECCOM Feedback / Recommendations

PF is compliant and compatible with the ongoing service mesh implementation (https://gerrit.onap.org/r/c/oom/+/128543) for ONAP. 

✅

Crypto Used Network

Does your software have network communications inbound or outbound? If so, do you support secure protocols for all such network communications?

Your Answers-Please ExplainSECCOM Feedback / Recommendations

PF only communicates with components within ONAP.

PF's primary communication is through HTTP.

PF uses Kafka or REST api interfaces between PF components and service mesh for other communications.

As mentioned above, we need to add to documentation that PF is supposed to run within OOM deployment. That said, SM is managing all communication.


?

is HTTP protected by mesh and HTTPS?

  • yes

Crypto Verification Private

Does your software use outbound HTTPS connections? If so, does it perform certificate verification before sending HTTP headers with private information (such as secure cookies)

Your Answers-Please ExplainSECCOM Feedback / Recommendations

PF is compliant and compatible with the ongoing service mesh implementation (https://gerrit.onap.org/r/c/oom/+/128543) for ONAP. 

As mentioned above, we need to add to documentation that PF is supposed to run within OOM deployment. That said, SM is managing all communication.

❌

Doesn't answer the question