jenkins

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 3538 is passing Here is how to embed it:

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

        

 Basics 1/5

  • Identification

    Jenkins automation server

  • Prerequisites


    The project MUST achieve a silver level badge. [achieve_silver]

  • Project oversight


    Mradi LAZIMA uwe na "bus factor" ya 2 au zaidi. (URL required) [bus_factor]

    The project has a bus factor of over 2 https://github.com/orgs/jenkinsci/people



    Mradi LAZIMA uwe na angalau wachangiaji wawili wasiohusika. (URL required) [contributors_unassociated]

  • Other


    The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file: SPDX-License-Identifier: [SPDX license expression for project]. [license_per_file]

  • Public version-controlled source repository


    The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.



    The project MUST clearly identify small tasks that can be performed by new or casual contributors. (URL required) [small_tasks]

    We provide lists of small tasks (aka good first issues) on the Jenkins Participate and Contribute pages. For example, here you can find references to issue lists for newcomer code contributors.



    The project MUST require two-factor authentication (2FA) for developers for changing a central repository or accessing sensitive data (such as private vulnerability reports). This 2FA mechanism MAY use mechanisms without cryptographic mechanisms such as SMS, though that is not recommended. [require_2FA]


    The project's two-factor authentication (2FA) SHOULD use cryptographic mechanisms to prevent impersonation. Short Message Service (SMS) based 2FA, by itself, does NOT meet this criterion, since it is not encrypted. [secure_2FA]

  • Coding standards


    Mradi LAZIMA uandike mahitaji yake ya kukagua msimbo, pamoja na jinsi ukaguzi wa nambari unafanywa, nini lazima ichunguzwe, na nini kinachohitajika ili ikubalike. (URL required) [code_review_standards]

    Jenkins core has a documented code review process, see the guidelines here. The key expectations from the pull request are also documented in the pull request template inside the Jenkins core repository.



    The project MUST have at least 50% of all proposed modifications reviewed before release by a person other than the author, to determine if it is a worthwhile modification and free of known issues which would argue against its inclusion [two_person_review]

    In the Jenkins core pull request review process, we require at least two approvals for all non-trivial changes. Pull request authors cannot approve their own pull requests.


  • Working build system


    The project MUST have a reproducible build. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). (URL required) [build_reproducible]

    The Jenkins project uses Jenkins to build and release software.

    • The CI environment uses standard containers defined in our infrastructure, and the build process is defined-as-code via Maven definitions and Jenkinsfile in the Jenkins core repository.
    • The release environment is fully defined -as-code in jenkins-infra/release
    • Native installer Installer packaging logic is defined as code in jenkinsci/packaging
    • Docker packaging is defined as code in jenkinsci/docker

  • Automated test suite


    A test suite MUST be invocable in a standard way for that language. (URL required) [test_invocation]

    Jenkins Core unit and integration test suites can be invoked using the standard Maven Surefire Plugin. JavaScript unit tests can be launched via YARN. See Jenkins Core - Testing Changes for more information.

    Acceptance Test Harness tests can be invoked using the standard Maven Surefire Plugin, the test repository is located in jenkinsci/acceptance-test-harness/



    The project MUST implement continuous integration, where new or changed code is frequently integrated into a central code repository and automated tests are run on the result. (URL required) [test_continuous_integration]

    We use Jenkins-on-Jenkins: https://ci.jenkins.io/



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

    We do not regularly control the test coverage for the Jenkins core



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

    We do not regularly control the test coverage for the Jenkins core


  • 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 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 MUST 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 supports TLS for all of its network communications.



    The software produced by the project MUST, 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]

    The project supports at TLS version 1.2, as provided by this property: -Dhttps.protocols=TLSv1.2


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


    The project website, repository (if accessible via the web), and download site (if separate) MUST include key hardening headers with nonpermissive values. (URL required) [hardened_site]

    // X-Content-Type-Options was not set to "nosniff". // One or more of the required security hardening headers is missing.


  • Other security issues


    The project MUST have performed a security review within the last 5 years. This review MUST consider the security requirements and security boundary. [security_review]


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

  • Dynamic code analysis


    The project MUST apply at least one dynamic analysis tool to any proposed major production release of the software produced by the project before its release. [dynamic_analysis]

    We do not use dynamic analysis tools as a part of our CI/CD pipeline. Some Jenkins users run scans and sometimes report vulnerabilities to the project, but it is quite rare.



    The project SHOULD include many run-time assertions in the software it produces and check those assertions during dynamic analysis. [dynamic_analysis_enable_assertions]

    Jenkins project does not use dynamic analysis tools as a part of the CI/CD pipeline. On the other hand, Jenkins instances produce run-time events (logs, metrics, etc.) which are exposed to monitoring tools and can be used for dynamic analysis



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 Oleg Nenashev and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Oleg Nenashev.
Entry created on 2019-12-26 14:21:18 UTC, last updated on 2023-01-07 17:52:02 UTC. Last achieved passing badge on 2020-07-21 12:13:13 UTC.

Back