ONAP Optimization Framework (OOF)

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 1720 is passing Here is how to embed it:

These are the Passing level criteria. You can also view the Silver or Gold level criteria.

        

 Basics 13/13

  • Identification

    The ONAP Optimization Framework provides a declarative, policy- and model-driven functionality for creating and managing optimization applications for a broad range of use cases within ONAP. Specifically, it provides a framework for rapidly developing new optimization applications independent of how the underlying optimization modules are implemented.

    What programming language(s) are used to implement the project?
  • Basic project website content


    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]

    The following URL summarizes the ONAP Optimization Framework: https://wiki.onap.org/display/DW/Optimization+Framework+Project

    Specifically, the section "About ONAP Optimization Framework (OOF)" provides a succinct description.



    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    The following URL describes the process to join the community, developing software, https://wiki.onap.org/display/DW/Optimization+Framework+Project

    Specifically, the section "Getting Started with OOF" provides details and links on how to (a) join the community, (b) develop the software, (c) track status and provide feedback, and (d) create new issues, requirements, etc. It also has information on project logistics such as meetings and related wiki pages.



    The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution]

    The process could be found in the following URL: https://wiki.onap.org/display/DW/Development+Procedures+and+Policies



    The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]

    Acceptable contributions are based on the ONAP requirements captured here:

    https://wiki.onap.org/display/DW/Development+Procedures+and+Policies https://wiki.onap.org/display/DW/Developing+ONAP https://wiki.onap.org/display/DW/Developer+Best+Practices

    The Python code should meet the requirements except for the number of characters in a line of code specified by the styleguide https://google.github.io/styleguide/pyguide.html

    We are in the process of ensuring that the seed code is adapted per the Google Style Guide and will require that new commits meet pylint --rcfile=


  • FLOSS license

    What license(s) is the project released under?



    The software produced by the project MUST be released as FLOSS. [floss_license]

    The Apache-2.0 license is approved by the Open Source Initiative (OSI).



    It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]

    The Apache-2.0 license is approved by the Open Source Initiative (OSI).



    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]

    License is present in all the repositories of the OOF project (optf/osdf and optf/has): https://gerrit.onap.org/r/gitweb?p=optf/osdf.git;a=blob;f=LICENSE.txt


  • Documentation


    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]

    The documentation describing the project is being made available within the http://onap.readthedocs.io/en/latest/submodules/ hierarchy. Additional documentation is also available on the main OOF wiki.



    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]
  • Other


    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]

    Given only https: URLs.



    The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. [discussion]

    A mailing list is used for project related discussion. New users could also check, search the old discussion online at onap-discuss website: https://wiki.onap.org/display/DW/Joining+the+Community

    Additionally, a mailing list specific to OOF is also available: https://lists.onap.org/mailman/listinfo/onap-oof



    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]

    JIRA is used to track bugs. The whole website is in English. https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA



    The project MUST be maintained. [maintained]


(Advanced) What other users have additional rights to edit this badge entry? Currently: [3589, 6030, 6038]



  • Public version-controlled source repository


    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]

    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Tracking is provided by using a combination of JIRA and git history. Every commit has an user and a Jira number attached to it.

    Git history for OPTF's master branch:https://gerrit.onap.org/r/#/q/projects:+optf

    Jira for ONAP: https://jira.onap.org/projects/OPTFRA



    To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]

    Gerrit provides an temporary branch for reviewing and providing comments. Once approved, the code will be merged and the temporary branch will be removed. There is mechanism for obtaining snapshots corresponding to an arbitrary time point in the past.



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]

    Git and Gerrit are used.


  • Unique version numbering


    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]

    Release version is with format ${major}.${minor}.${patch} and will be updated accordingly for each release.



    It is SUGGESTED that the Semantic Versioning (SemVer) or Calendar Versioning (CalVer) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value. [version_semver]


    It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags]

    Each release will be tagged within the Gerrit repository per ONAP-wide requirements.


  • Release notes


    The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes]

    The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created. This criterion may be marked as not applicable (N/A) if users typically cannot practically update the software themselves (e.g., as is often true for kernel updates). This criterion applies only to the project results, not to its dependencies. If there are no release notes or there have been no publicly known vulnerabilities, choose N/A. [release_notes_vulns]

    Release notes with identified vulnerabilities will be provided in repository specific pages (the first release of the project is in May, 2018):

    https://onap.readthedocs.io/en/latest/submodules/optf/optf-osdf.git/docs/release-notes.html https://onap.readthedocs.io/en/latest/submodules/optf/optf-has.git/docs/release-notes.html

    No vulnerabilities have yet been identified.


  • Bug-reporting process


    The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process]

    The description of the process can be found in the following URL: https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA



    The project SHOULD use an issue tracker for tracking individual issues. [report_tracker]

    Jira is used to track issues. https://jira.onap.org/projects/OPTFRA

    Additional details are provided at: https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA



    The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]

    The reported issues are being handled as soon as possible. Typically within the sprint.



    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]

    The reported issues are being handled as soon as possible. Typically within two months.



    The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive]

    The report of issues are listed here: https://wiki.onap.org/display/DW/Issue+Reports (OOF specific issues are under the OPTFRA tag)


  • Vulnerability report process


    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]

    The process on how to report a vulnerability can be found in https://wiki.onap.org/display/DW/ONAP+Vulnerability+Management



    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]

    Private vulnerability reports are not supported. However, information on how to report vulnerabilities privately is provided on the project page.

    https://wiki.onap.org/display/DW/Optimization+Framework+Project



    The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. [vulnerability_report_response]

    We have followed the process via JIRA and responded rapidly. As an example, we identified some vulnerabilities in the build project (outside of optf), and we quickly identified it as a non-optf problem, then performed the analysis and provided the report to the broader ONAP group that helped fix the problem the same day.


  • Working build system


    If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. [build]

    OOF uses Jenkins to automatically build the software. https://jenkins.onap.org/view/optf/



    It is SUGGESTED that common tools be used for building the software. [build_common_tools]

    Jenkins with Maven is used to build the project. https://jenkins.onap.org/view/optf/



    The project SHOULD be buildable using only FLOSS tools. [build_floss_tools]

    Jenkins with Maven is used to build the project. https://jenkins.onap.org/view/optf/


  • Automated test suite


    The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]

    OOF uses tox and coverage to run the unit tests. The unit tests are part of the optf source distribution (Apache-2.0)



    A test suite SHOULD be invocable in a standard way for that language. [test_invocation]

    OOF uses tox and coverage to run the unit tests. This is a standard way for Python.



    It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. [test_most]

    OOF is currently using only the master branch for release (individual branches will be covered as they are developed). Each gerrit commit resulting in a temporary branch is tested with these unit tests.



    It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). [test_continuous_integration]

    All commits in review for OOF trigger a build and test process (unit tests, integration tests, and functional tests). Note: functional tests are in progress and expected to be delivered before the last development Sprint of OOF's first release. https://jenkins.onap.org/view/optf/


  • New functionality testing


    The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy]

    The code coverage is evaluated by Sonar. If there are no unit tests for the new functionality, the committers will reject the commit (and work towards getting new tests to be added). This is followed in OOF and is in line with ONAP-wide policy/guidelines.



    The project MUST have evidence that the test_policy for adding tests has been adhered to in the most recent major changes to the software produced by the project. [tests_are_added]

    Initial test code for OSDF has been augmented by unit tests and new code commits.



    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]

    The code coverage requirement is listed as a developer best practice here: https://wiki.onap.org/display/DW/Code+Coverage+and+Static+Code+Analysis


  • Warning flags


    The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. [warnings]

    Sonar is used to examine the quality of the source code. Sonar uses different rules to verify the quality of the code and to address the vulnerability of the code.



    The project MUST address warnings. [warnings_fixed]

    OOF prioritizes addressing vulnerabilities reported by Sonar.



    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    Sonarqube is used to analyze and report code smells and warnings, and the project is committed to fixing them.


  • Secure development knowledge


    The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]


    At least one of the project's primary developers MUST know of common kinds of errors that lead to vulnerabilities in this kind of software, as well as at least one method to counter or mitigate each of them. [know_common_errors]

  • Use basic good cryptographic practices

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    The software produced by the project MUST use, by default, only cryptographic protocols and algorithms that are publicly published and reviewed by experts (if cryptographic protocols and algorithms are used). [crypto_published]

    We use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347



    If the software produced by the project is an application or library, and its primary purpose is not to implement cryptography, then it SHOULD only call on software specifically designed to implement cryptographic functions; it SHOULD NOT re-implement its own. [crypto_call]

    We use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347



    All functionality in the software produced by the project that depends on cryptography MUST be implementable using FLOSS. [crypto_floss]

    We use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347



    The security mechanisms within the software produced by the project MUST use default keylengths that at least meet the NIST minimum requirements through the year 2030 (as stated in 2012). It MUST be possible to configure the software so that smaller keylengths are completely disabled. [crypto_keylength]

    We use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347



    The default security mechanisms within the software produced by the project MUST NOT depend on broken cryptographic algorithms (e.g., MD4, MD5, single DES, RC4, Dual_EC_DRBG), or use cipher modes that are inappropriate to the context, unless they are necessary to implement an interoperable protocol (where the protocol implemented is the most recent version of that standard broadly supported by the network ecosystem, that ecosystem requires the use of such an algorithm or mode, and that ecosystem does not offer any more secure alternative). The documentation MUST describe any relevant security risks and any known mitigations if these broken algorithms or modes are necessary for an interoperable protocol. [crypto_working]

    We use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347



    The default security mechanisms within the software produced by the project SHOULD NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). [crypto_weaknesses]

    We use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347



    The security mechanisms within the software produced by the project SHOULD implement perfect forward secrecy for key agreement protocols so a session key derived from a set of long-term keys cannot be compromised if one of the long-term keys is compromised in the future. [crypto_pfs]

    We use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347



    If the software produced by the project causes the storing of passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). See also OWASP Password Storage Cheat Sheet. [crypto_password_storage]

    In Beijing release, we are going to use AAF for user authentication and authorization.

    In general, we use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347



    The security mechanisms within the software produced by the project MUST generate all cryptographic keys and nonces using a cryptographically secure random number generator, and MUST NOT do so using generators that are cryptographically insecure. [crypto_random]

    In general, we use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347


  • Secured delivery against man-in-the-middle (MITM) attacks


    The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]

    In general, we use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347



    A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned]

    In general, we use ONAP-wide recommended cryptographic protocols and algorithms: https://wiki.onap.org/pages/viewpage.action?pageId=15995347


  • Publicly known vulnerabilities fixed


    There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]

    OOF uses tool like Sonar to detect vulnerabilities and fix it as soon as possible when find any. All repos within OOF are at "Passed" status in "Quality Gate" (except for optf/has, which is adding the required test cases to move to "passed").

    https://sonar.onap.org/projects?search=optf&sort=-analysis_date



    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

    The OOF team has diligently fixed all vulnerabilities and identified the ones in upstream projects (including build systems) and worked with broader ONAP release management team to address the upstream issues.

    All repos within OOF are at "Passed" status in "Quality Gate" (except for optf/has, which is adding the required test cases to move to "passed"): https://sonar.onap.org/projects?search=optf&sort=-analysis_date


  • Other security issues


    The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]

    We currently use a "test configuration" for default configuration. Currently credentials may be stored as plain text in the Docker container, but are not "leaked", as they aren't intended to limit public access. To the best of our knowledge, and data from SONAR static code checks, there is no code in the OOF project that leaks any credentials. Furthermore, the project is using AAF-SMS to store credentials (https://wiki.onap.org/display/DW/Using+SMS).


  • Static code analysis


    At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. [static_analysis]

    Sonar is used for static code analysis.

    Status of all repos within OOF are available at: https://sonar.onap.org/projects?search=optf&sort=-analysis_date



    It is SUGGESTED that at least one of the static analysis tools used for the static_analysis criterion include rules or approaches to look for common vulnerabilities in the analyzed language or environment. [static_analysis_common_vulnerabilities]

    Sonar uses different rules for static code analysis. The list of rules used by OOF is at: https://sonar.onap.org/coding_rules#languages=py



    All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [static_analysis_fixed]

    The OOF team has diligently fixed all vulnerabilities and identified the ones in upstream projects (including build systems) and worked with broader ONAP release management team to address the upstream issues.

    All repos within OOF are at "Passed" status in "Quality Gate" (except for optf/has, which is adding the required test cases to move to "passed"): https://sonar.onap.org/projects?search=optf&sort=-analysis_date



    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]

    The Sonar scans are triggered daily and also for every code commit.


  • Dynamic code analysis


    It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. [dynamic_analysis]

    The code is written in Python, which is a memory-safe language. Together with unit tests, monitoring the processes, and static code tools, we will cover most of the issues.



    It is SUGGESTED that if the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). [dynamic_analysis_unsafe]

    The code is written in Python, which is a memory-safe language.



    It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing) which enables many assertions. In many cases these assertions should not be enabled in production builds. [dynamic_analysis_enable_assertions]

    While the runtime assertions will not be of much use for this, we will explore this option in more detail.



    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. [dynamic_analysis_fixed]

    We will explore this after the dynamic assertions are explored and introduced into the system. This is a very long stretch goal.



This data is available under the Creative Commons Attribution version 3.0 or later license (CC-BY-3.0+). All are free to share and adapt the data, but must give appropriate credit. Please credit mrsjackson76 and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: mrsjackson76.
Entry created on 2018-03-13 13:12:11 UTC, last updated on 2021-02-17 10:13:35 UTC. Last lost passing badge on 2019-05-28 15:49:38 UTC. Last achieved passing badge on 2019-11-05 18:02:59 UTC.

Back