ONAP DCAE

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 1718 is silver 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

    Data Collection Analytics and Events (DCAE) is the data collection and analysis subsystem of ONAP. Its functions include among other things the collection of measurement and fault data from the network entities (Virtual Network Functions, Physical Network Functions, etc). It provides also a framework for the normalization of data format, the transportation of data, analysis of data, and generations of ONAP events which can be received by other ONAP components such as Policy for subsequent operations like closed loops.

    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 project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    The following URLs describe the process to join the community, developing the software and provide feekback: https://wiki.onap.org/display/DW/Joining+the+Community https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA https://wiki.onap.org/display/DW/Developing+ONAP.
    In addition, DCAE has a web page providing DCAE specific information: https://wiki.onap.org/display/DW/DCAE+Contribution+and+Development.



    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.
    In addition, DCAE has a web page providing DCAE specific information: https://wiki.onap.org/display/DW/DCAE+Contribution+and+Development.



    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]

    The process could be found in the following URL: https://wiki.onap.org/display/DW/Development+Procedures+and+Policies.
    In addition, DCAE has a web page providing DCAE specific information: https://wiki.onap.org/display/DW/DCAE+Contribution+and+Development.


  • 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 project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]
  • Documentation


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

    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. More details can be found at: https://wiki.onap.org/display/DW/Joining+the+Community



    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. Tracking Issues with: https://jira.onap.org, under DCAEGEN2 board.



    The project MUST be maintained. [maintained]


(Advanced) What other users have additional rights to edit this badge entry? Currently: [1597, 1992, 2630]



  • Public version-controlled source repository


    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.



    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 temperate branch for reviewing and providing comments. Once approved, the code will be merged and the temperate branch will be removed.



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

    Git and and its code review add-on 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 is tagged within the Gerrit repository.


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

    Release notes include as part of DCAE documentation. For example, R1 release notes can be found at: http://onap.readthedocs.io/en/amsterdam/submodules/dcaegen2.git/docs/sections/release-notes.html#id1



    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]

    R1 release notes can be found at: http://onap.readthedocs.io/en/amsterdam/submodules/dcaegen2.git/docs/sections/release-notes.html#id1. The known vulnerabilities are reported under the "Known issues" and "Security Issues" sections.


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

    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.



    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.



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

    All ticket reporting and commenting are available on https://jira.onap.org. The Git/Gerrit system enforces a submission gating function that any code change must include a JIRA Issue ID, which the corresponding JIRA ticket's page links as part of progress report.


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

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

    By default all vulnerability reports are private unless modified by the reporter.



    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]

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

    Jenkins is used for building all software components (e.g. jar, war, pypi wheel packages) as well as docker images: https://jenkins.onap.org.



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

    Maven, pip, are used to build software components (jar, war, wheel, etc). Docker is used to build software packages (docker container image)



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

    Maven and docker are under Apache 2.0. Pip is licensed under MIT.


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

    Junit (under EPL) for Java and Clojure components.
    Pytest (under MIT) for python projects.
    Rebar3 (under Apache 2) for Erlang code. Robot Testing Framework (under Apache 2) for docker container level testing.



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

    Junit tests are invoked from mvn. Pytest tests are invoked by running pytest from command line. Rebar3 tests are invoked from command line by running rebarr3. All are included as part of Jenkin builds. All are standard testing tools invoked in standard way. Robot Framework tests are invoked by standard Robot methodology, also triggered by Jenkins build jobs. https://wiki.onap.org/display/DW/Continuous+Integration https://wiki.onap.org/pages/viewpage.action?pageId=4718718



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

    The combination of Junit/pytest/rebar3, and robot testing framework has the ability to cover all the branches and input fields



    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]

    For each pull request, the project needs to be built successfully before the Merge option becomes activated. The test will be run automatically during the building process as well. Once build successfully and all tests has past, the Merge option will be activated.

    https://wiki.onap.org/display/DW/Continuous+Integration https://wiki.onap.org/pages/viewpage.action?pageId=4718718


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

    ONAP uses Robot testing framework for automated integration test. Passing CSIT test cases is a requirement for passing code freeze mile stone: https://wiki.onap.org/display/DW/Deliverable+for+Code+Freeze+Milestone+Checklist+Template , under "Integration and Testing".



    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]

    CSIT test results available on jenkins build result reporting: https://jenkins.onap.org/view/CSIT/



    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]
  • 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]

    style check, SONAR reporting, and CLM scanning



    The project MUST address warnings. [warnings_fixed]

    Project warning across dcaegen2 repo for R3 <1%



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

    Review/approval process includes validating verify jobs for dcaegen2 project - https://jenkins.onap.org/view/dcaegen2/


  • 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 present time, majority of DCAE components are contributed by developers engaged in ONAP for couple releases. All developers are generally familiar with secure software development practice and experienced in vulnerability resolution. The CLM scan reports are periodically assessed and developers address the vulnerabilities identified every release.



    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]

    At present time, majority of DCAE components are contributed by developers from AT&T. AT&T developers are generally familiar with secure software development practice and experienced in vulnerability resolution because of their internal practice of using Fortify code analysis tool from HP.


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


    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]


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

    TLS for secure API calling.



    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]


    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]


    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]


    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]


    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]

    The dcaegen2/collectors/ves project stores password (when VNF authentication mode is enabled) but not using iterated hashes with a per-user salt. Not applicable for other projects.



    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]

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

    HTTPS is used to download all ONAP artifacts, and some are signed by the Linux Foundation.



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

    There is no known use of such in DCAE.


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


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

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

    There are several instances of passwords included in the public repos of DCAE as part of the testing/demo deployment configuration.
    They serve as examples for setting up functional demonstrations, and not intended to limit public access.


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

    Sonatype CLM scan is applied for static code and dependency security vulnerability reporting. Its results are available on https://nexus-iq.wl.linuxfoundation.org/assets/index.html. Language specific unit testing is mandatory for all ONAP projects. Results are reported to SONAR server.



    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]

    Sonatype CLM scan is applied for static code and dependency security vulnerability reporting. Its results are available on https://nexus-iq.wl.linuxfoundation.org/assets/index.html. The reports contained details of the vulnerabilities and suggestions of fixes.



    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]


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

    The CLM scan is triggered by key-word command in the Gerrit review system. It is applied by PTL and committers after new code changes are merged into the system.


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

    ONAP does not employ dynamic code analysis beyond what SONAR and CLM (Nexus IQ) analysis. The security subcommittee is undergoing a task identifying suitable dynamic analysis tool but at this time none has been identified.

    Prior to El-Alto release - Samsung performed PEN test for all ONAP components and created jira (OJSI) for remediation - https://jira.onap.org/browse/OJSI-201?jql=project%20%3D%20OJSI



    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]

    DCAEGEN2 components are implemented in Java, JavaScript, Cloujour, Python, and Erlang. Not using C or C++.



    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]

    ONAP does not employ dynamic code analysis beyond what SONAR and CLM (Nexus IQ) analysis. The security subcommittee is undergoing a task identifying suitable dynamic analysis tool but at this time none has been identified.



    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]

    ONAP does not employ dynamic code analysis beyond what SONAR and CLM (Nexus IQ) analysis. The security subcommittee is undergoing a task identifying suitable dynamic analysis tool but at this time none has been identified.



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-12 16:44:10 UTC, last updated on 2024-03-18 15:53:28 UTC. Last achieved passing badge on 2019-03-26 20:19:47 UTC.

Back