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 Silver level criteria. You can also view the Passing or Gold level criteria.

        

 Basics 17/17 ●

  • 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.

  • Prerequisites


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

    The information on how to contribute MUST 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=


  • Project oversight


    Enough for a badge!

    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]

    ONAP requires both a Developer Certificate of Origin (DCO), and a Contributor License Agreement (CLA). https://wiki.onap.org/display/DW/Contribution+Agreements


    Enough for a badge!

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]

    The project governance is described at https://wiki.onap.org/display/DW/Community+Offices+and+Governance

    Further information can be found at https://wiki.onap.org/display/DW/ONAP+Technical+Community+Document


    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]

    Follows LF Code of conduct

    https://www.linuxfoundation.org/code-of-conduct/


    Enough for a badge!

    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]

    The key roles in the project and their responsibilities are described at https://wiki.onap.org/display/DW/Community+Offices+and+Governance Current members are listed at https://wiki.onap.org/pages/viewpage.action?pageId=8226539


    Enough for a badge!

    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    OOF has multiple committers and multiple contributes who are listed in : https://wiki.onap.org/display/DW/Resources+and+Repositories#ResourcesandRepositories-OptimizationFramework

    All committers have access and rights to maintain the code base, approve and review incoming changes and release a new version of the artifact. This will let the project continue with minimal to no interruption if one person is incapacitated. More committers can be included in the project, as this is supported by the linux foundation.


    Enough for a badge!

    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]

    The project covered in this report has more than 2 persons who actively contribute and maintain code. At any point of time, the list of committers for the project is maintained here : https://wiki.onap.org/display/DW/Resources+and+Repositories#ResourcesandRepositories-OptimizationFramework


  • Documentation


    Enough for a badge!

    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]

    The road map for OOF can be found in the corresponding release planning phase. For example,

    https://wiki.onap.org/display/DW/OOF+Dublin+M1+Release+Planning


    Enough for a badge!

    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]

    The high-level design and architecture of OOF (and its evolutions) can be found under each release planning phase. For example, in Dublin release:

    https://wiki.onap.org/display/DW/OOF+Dublin+%28R4%29+Architecture+Alignment


    Enough for a badge!

    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]

    A security sub-committee oversees the release requirements, best practices. Agreed recommendations become integral parts of an ONAP release and are assessed during milestones: https://wiki.onap.org/display/DW/ONAP+Security+coordination

    Further, the release note clearly states what has been achieved, along with the release checklists and links to individual JIRA items that covers the above security requirements. OOF adheres to the overall security requirements of ONAP and also provides a per release vulnerability threat.


    Enough for a badge!

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]

    Information on setting up ONAP can be found at https://onap.readthedocs.io/en/latest/guides/onap-developer/settingup/index.html.

    Project specific guides are also available: https://wiki.onap.org/display/DW/HAS+Developer+Guide


    Enough for a badge!

    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]

    ONAP projects are required to update all documents on readthedocs.io as a part of the release process. The current documentation for OOF can be found at:

    https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#optimization-framework


    Enough for a badge!

    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]

    The project website displays the latest badge.

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


  • Accessibility and internationalization


    Enough for a badge!

    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]

    OOF has no user interfaces and is a runtime component; the project site is configurable for font size/colors.


    Enough for a badge!

    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]

    OOF doesn't provide an end user interface currently.


  • Other


    Enough for a badge!

    If the project sites (website, repository, and download URLs) store 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). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]

    All passwords are stored either as kubernetes secrets or imported from a secret management service. They are not stored as plain text within the project


  • Previous versions


    Enough for a badge!

    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    All major releases are tagged in gerrit and the artifacts are stored with the release information on onap.nexus. So we can access all old versions of the artifact. If and when an upgrade requires certain steps to be followed they are being added to the release documents as needed


  • Bug-reporting process


    Enough for a badge!

    The project MUST 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


  • Vulnerability report process


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    Vulnerabilities can be reported using the link https://wiki.onap.org/pages/viewpage.action?pageId=6591711

    The wiki page explains on how to report a vulnerability and how to report anonymously if you do not want the credit for it.


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]

    Vulnerability handling is documented in https://wiki.onap.org/pages/viewpage.action?pageId=6591711


  • Coding standards


    Enough for a badge!

    The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards]

    Google coding style is used in ONAP https://github.com/google/styleguide


    Enough for a badge!

    The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced]

    SONAR compile time and Static Reporting tools enforce coding styles. For java applications, maven-checkstyle-plugin is used and is referenced in the parent POM. For Python applications, PEP8 checks is used.


  • Working build system


    Enough for a badge!

    Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables]

    The project does not create native binaries.


    Enough for a badge!

    The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_preserve_debug]

    The project does not create native binaries. Each components build and installation process provides debugging information (eg. pip install)


    Enough for a badge!

    The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive]

    There are no cross dependencies.


    Enough for a badge!

    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]

    All releases are tagged in gerrit(git), and the builds are controlled using jenkins. By providing the git tag information the same image can be build over and over again with same bit-for-bit result.


  • Installation system


    Enough for a badge!

    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]

    All packages are delivered either as jar artifacts or as docker images. * Maven artifacts can be removed using the pom file. * Docker containers can be spun up easily using helm, and the orchestration through Kubernetes allows easy exclusion of specific containers. * Python components can be easily installed via pip


    Enough for a badge!

    The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). [installation_standard_variables]

    Docker containers are used for installation, so the conventions of the host operating system are not relevant. Python components are typically installed within their own virtual environments, which is a best practice.


    Enough for a badge!

    The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick]

    OOM based deployment is documented clearly in https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_quickstart_guide.html. Each independent component has its own developers guide that prepares the required dev environment, the process of which is well automated.

    For example: https://wiki.onap.org/display/DW/HAS+Developer+Guide


  • Externally-maintained components


    Enough for a badge!

    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]

    External dependencies are controlled using the pom file for java projects, and via requirements.txt that is used by pip for python projects.

    https://gerrit.onap.org/r/gitweb?p=optf/has.git;a=blob;f=conductor/requirements.txt;h=d6d413d506df3fe82d2779f1e16fa2093a4f40f2;hb=HEAD https://gerrit.onap.org/r/gitweb?p=optf/osdf.git;a=blob;f=requirements.txt;h=23dc1b510f658d35dd8147b91b0201ef6fc42f7c;hb=HEAD https://gerrit.onap.org/r/gitweb?p=optf/cmso.git;a=blob;f=cmso-topology/pom.xml;h=553fe91bb27c9eb44d9bca8b78d991f1533c2f19;hb=HEAD


    Enough for a badge!

    Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring]

    NexusIQ sonar scan is run on the project on a weekly basis: https://jenkins.onap.org/view/optf/


    Enough for a badge!

    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]

    Identifying and Updating an external component simply involves making an update to the pom.xml or requirements.txt file for that project.


    Enough for a badge!

    The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current]

    We avoid using deprecated and obsolete functions and APIs when possible. We use open source solutions in every case and choose up-to-date versions of the components.


  • Automated test suite


    Enough for a badge!

    An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing]

    Automatic test suites are run every time before merging the code. The code check in cannot pass with out jenkins posting a +1 on the review.

    https://jenkins.onap.org/view/optf/


    Enough for a badge!

    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    Tests are added for new code contributions and as regression occurs.


    Not enough for a badge.

    The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80]

    Code coverage is being enhanced progressively over each release, but it hasn't yet breached the 80% target.


  • New functionality testing


    Enough for a badge!

    The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated]

    Contributing guide lines for development is recorded in https://wiki.onap.org/display/DW/Development+Procedures+and+Policies


    Enough for a badge!

    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [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


    Enough for a badge!

    Projects MUST 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


    Unknown required information, not enough for a badge.

    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]

  • 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.

    Enough for a badge!

    The default security mechanisms within the software produced by the project MUST 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


    Unknown required information, not enough for a badge.

    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

    Enough for a badge!

    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    All authentication credentials are being managed by an external secret management service. It will be fetched by the app during startup.


    Enough for a badge!

    The software produced by the project SHOULD support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 SHOULD be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

    The project uses HTTPS protocol with TLS1.2


    Enough for a badge!

    The software produced by the project SHOULD, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

    OOF components use AAF based certificate verification. https://jira.onap.org/browse/OPTFRA-223 https://jira.onap.org/browse/OPTFRA-263 https://jira.onap.org/browse/OPTFRA-461 https://jira.onap.org/browse/OPTFRA-391 https://jira.onap.org/browse/OPTFRA-293


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]

    OOF components use AAF based certificate verification. https://jira.onap.org/browse/OPTFRA-223 https://jira.onap.org/browse/OPTFRA-263 https://jira.onap.org/browse/OPTFRA-461 https://jira.onap.org/browse/OPTFRA-391 https://jira.onap.org/browse/OPTFRA-293


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

    Role based authentication with AAF certs is performed prior to any processing.


  • Secure release


    Unknown required information, not enough for a badge.

    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]

    Unknown required information, not enough for a badge.

    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

  • Other security issues


    Not enough for a badge.

    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]

    All OOF APIs are exposed only within the ONAP cluster except opt_eng which exposes APIs to the user to create, update, and delete optimization models. This is newly introduced in the frankfurt release and it is not part of the deployment. There is a basic input validation being done for these APIs, but it has to be improved to reject invalid inputs.


    Unknown required information, not enough for a badge.

    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]

    Unknown required information, not enough for a badge.

    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]

  • Static code analysis


    Enough for a badge!

    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [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


  • Dynamic code analysis


    Enough for a badge!

    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) MUST 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.



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