libjxl

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 7845 is silver Here is how to embed it:

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

        

 Basics 5/5

  • Identification

    JPEG XL image format reference implementation, including a library for encoding and decoding JPEG XL images as well as command line tools (cjxl, djxl, jxlinfo) and various related tools (e.g. perceptual metrics, color conversion and benchmarking tools).

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

    Hard to assess with the truck-factor tool since initial development was private and all commits were authored by "jpegxl-bot". But there are at least 4 project maintainers who are sufficiently knowledgeable and competent, so the bus factor is 4 or more. As can be seen on https://github.com/libjxl/libjxl/graphs/contributors, there are at least 6 project members who have made significant contributions over a long time span in the past and are still recently active.



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

    Significant contributors include: - Jon Sneyers (Cloudinary) - Moritz Firsching, Luca Versari, Evgenii Kliuchnikov, Jyrki Alakuijala, Sami Boukortt, Zoltan Szabadka, Jan Wassenberg (Google) See https://github.com/libjxl/libjxl/graphs/contributors


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

    All source files start with the following:

    // Copyright (c) the JPEG XL Project Authors. All rights reserved. // // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE 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]

    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]

    2FA is required for everyone in the libjxl github organization.



    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]

    TOTP is used for 2FA, not SMS.


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

    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]

    All pull requests require review/approval by at least one person other than the author, and this is enforced. For more significant proposed modifications, typically at least two reviews by a person other than the author are done, although this is not enforced.


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

    Building for various platforms is done as part of the CI, see e.g. https://github.com/libjxl/libjxl/actions/workflows/release.yaml


  • Automated test suite


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

    The gtest framework is used for this and testing will be done automatically as part of building unless -DBUILD_TESTING=OFF is specified. A script is provided (https://github.com/libjxl/libjxl/blob/main/ci.sh) to easily do building and testing with various build options (e.g. msan, asan etc).



    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]

    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]

    Currently the automated coverage testing only reaches 84%, see https://app.codecov.io/gh/libjxl/libjxl Reaching 90% is not impossible but it would require adding many explicit tests involving invalid inputs (many of the uncovered statements), which is something that is better tested with fuzzer-testing than with unit tests.



    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]

    Currently the automated coverage testing reaches 84%, see https://app.codecov.io/gh/libjxl/libjxl


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

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

    Hardening compiler flags are indeed typically used in builds intended for widespread distribution. See e.g. https://salsa.debian.org/debian-phototools-team/highway/-/blob/master/debian/rules#L6 and https://github.com/libjxl/libjxl/pull/2834#issuecomment-1761156078


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

    This is done as part of CI, see https://github.com/libjxl/libjxl/actions/workflows/fuzz.yml It is also done in the OSS-Fuzz project.



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

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

Project badge entry owned by: Jon Sneyers.
Entry created on 2023-09-19 14:13:59 UTC, last updated on 2023-10-13 09:14:45 UTC. Last achieved passing badge on 2023-09-19 15:13:34 UTC.

Back