bitmath

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.

There is no set of practices that can guarantee that software will never have defects or vulnerabilities; even formal methods can fail if the specifications or assumptions are wrong. Nor is there any set of practices that can guarantee that a project will sustain a healthy and well-functioning development community. However, following best practices can help improve the results of projects. For example, some practices enable multi-person review before release, which can both help find otherwise hard-to-find technical vulnerabilities and help build trust and a desire for repeated interaction among developers from different companies. To earn a badge, all MUST and MUST NOT criteria must be met, all SHOULD criteria must be met OR be unmet with justification, and all SUGGESTED criteria must be met OR unmet (we want them considered at least). If you want to enter justification text as a generic comment, instead of being a rationale that the situation is acceptable, start the text block with '//' followed by a space. Feedback is welcome via the GitHub site as issues or pull requests There is also a mailing list for general discussion.

We gladly provide the information in several locales, however, if there is any conflict or inconsistency between the translations, the English version is the authoritative version.
If this is your project, please show your baseline badge status on your project page! The baseline badge status looks like this: Baseline badge level for project 12749 is baseline-2 Here is how to embed the baseline badge:
You can show your baseline badge status by embedding this in your markdown file:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/12749/baseline)](https://www.bestpractices.dev/projects/12749)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/12749"><img src="https://www.bestpractices.dev/projects/12749/baseline"></a>


These are the Baseline Level 3 criteria. These criteria are from baseline version v2025.10.10 with updated criteria text from version v2026.02.19. Criteria that are new in version v2026.02.19 are labeled "future" and will begin to be enforced starting 2026-06-01. Please provide answers to the "future" criteria before that date.

Baseline Series: Baseline Level 1 Baseline Level 2 Baseline Level 3

        

 Basics

  • General

    Note that other projects may use the same name.

    Python module to work with file sizes like numbers - convert, compare, sort, and format across any prefix unit

    Please use SPDX license expression format; examples include "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", and "(BSD-2-Clause OR Ruby)". Do not include single quotes or double quotes.
    If there is more than one language, list them as comma-separated values (spaces optional) and sort them from most to least used. If there is a long list, please list at least the first three most common ones. If there is no language (e.g., this is a documentation-only or test-only project), use the single character "-". Please use a conventional capitalization for each language, e.g., "JavaScript".
    The Common Platform Enumeration (CPE) is a structured naming scheme for information technology systems, software, and packages. It is used in a number of systems and databases when reporting vulnerabilities.

 Controls 20/21 ●

  • Controls


    Enough for a badge!

    When a job is assigned permissions in a CI/CD pipeline, the source code or configuration MUST only assign the minimum privileges necessary for the corresponding activity. [OSPS-AC-04.02]
    Configure the project's CI/CD pipelines to assign the lowest available permissions to users and services by default, elevating permissions only when necessary for specific tasks. In some version control systems, this may be possible at the organizational or repository level. If not, set permissions at the top level of the pipeline.

    All workflows in .github/workflows/ declare permissions: read-all at top level, and every job-level elevation (security-events: write for SARIF upload, id-token: write for OIDC PyPI publish, contents: write only on the publish job for attaching the SBOM to the GitHub release) is the minimum required for that step. Verifiable at https://github.com/timlnx/bitmath/tree/master/.github/workflows


    Enough for a badge!

    (Future criterion) CI/CD pipelines which accept trusted collaborator input MUST sanitize and validate that input prior to use in the pipeline. [OSPS-BR-01.04]
    CI/CD pipelines should sanitize (quote, escape or exit on expected values) all collaborator inputs on explicit workflow executions. While collaborators are generally trusted, manual inputs to a workflow cannot be reviewed and could be abused by an account takeover or insider threat.

    The workflow_dispatch triggers on bandit.yml, scorecard.yml, and sca.yml accept zero inputs (no inputs: block), so there is no untrusted collaborator-provided data flowing into any pipeline step.


    Enough for a badge!

    When an official release is created, all assets within that release MUST be clearly associated with the release identifier or another unique identifier for the asset. [OSPS-BR-02.02]
    Assign a unique version identifier to each software asset produced by the project, following a consistent naming convention or numbering scheme. Examples include SemVer, CalVer, or git commit id.

    All release assets carry the SemVer version: bitmath-<version>-py3-none-any.whl, bitmath-<version>.tar.gz, and the new bitmath-<version>.cdx.json SBOM. Verifiable on any release at https://github.com/timlnx/bitmath/releases and https://pypi.org/project/bitmath/


    Enough for a badge!

    The project MUST define a policy for managing secrets and credentials used by the project. The policy should include guidelines for storing, accessing, and rotating secrets and credentials. [OSPS-BR-07.02]
    Document how secrets and credentials are managed and used within the project. This should include details on how secrets are stored (e.g., using a secrets management tool), how access is controlled, and how secrets are rotated or updated. Ensure that sensitive information is not hard-coded in the source code or stored in version control systems.

    The Secrets and Credentials Policy section of SECURITY.md (https://github.com/timlnx/bitmath/blob/master/SECURITY.md) documents what secrets the project handles (none long-lived, PyPI auth via OIDC Trusted Publishing), storage (no secrets in the repo, zero GitHub Actions secrets configured), access control, rotation (short-lived OIDC tokens rotated per workflow run), and incident response.


    Enough for a badge!

    When the project has made a release, the project documentation MUST contain instructions to verify the integrity and authenticity of the release assets. [OSPS-DO-03.01]
    Instructions in the project should contain information about the technology used, the commands to run, and the expected output. When possible, avoid storing this documentation in the same location as the build and release pipeline to avoid a single breach compromising both the software and the documentation for verifying the integrity of the software.

    VERIFICATION.md (https://github.com/timlnx/bitmath/blob/master/VERIFICATION.md) documents SHA-256 hash verification (automatic via pip, plus manual shasum -a 256 instructions cross-referencing PyPI's published hashes) and CycloneDX SBOM verification with cyclonedx-cli. The document lives separately from publish.yml so a single compromise cannot tamper with both the release and the verification instructions.


    Enough for a badge!

    When the project has made a release, the project documentation MUST contain instructions to verify the expected identity of the person or process authoring the software release. [OSPS-DO-03.02]
    The expected identity may be in the form of key IDs used to sign, issuer and identity from a sigstore certificate, or other similar forms. When possible, avoid storing this documentation in the same location as the build and release pipeline to avoid a single breach compromising both the software and the documentation for verifying the integrity of the software.

    VERIFICATION.md documents PEP 740 attestation verification via the pypi-attestations CLI, including the expected identity binding (repository timlnx/bitmath, workflow .github/workflows/publish.yml, ref refs/tags/<version>). The Sigstore signing chain backs the attestation, so no long-lived signing key is involved.


    Enough for a badge!

    When the project has made a release, the project documentation MUST include a descriptive statement about the scope and duration of support for each release. [OSPS-DO-04.01]
    In order to communicate the scope and duration of support for the project's released software assets, the project should have a SUPPORT.md file, a "Support" section in SECURITY.md, or other documentation explaining the support lifecycle, including the expected duration of support for each release, the types of support provided (e.g., bug fixes, security updates), and any relevant policies or procedures for obtaining support.

    SECURITY.md (https://github.com/timlnx/bitmath/blob/master/SECURITY.md) Supported Versions table plus the new "Scope of Support" and "Duration of Support" subsections explicitly state which versions receive security fixes, bug fixes, and functional changes, and what the EOL signaling looks like (12-month overlap on NEWS.rst before a major-version support window ends).


    Enough for a badge!

    When the project has made a release, the project documentation MUST provide a descriptive statement when releases or versions will no longer receive security updates. [OSPS-DO-05.01]
    In order to communicate the scope and duration of support for security fixes, the project should have a SUPPORT.md or other documentation explaining the project's policy for security updates.

    The Duration of Support subsection of SECURITY.md documents that the 2.x series receives security fixes as long as it is the current major, and that a future 3.x release would start a documented deprecation clock on 2.x with at least 12 months of overlap announced in NEWS.rst. The 1.x and pre-1.x series are stated as end-of-life.


    Enough for a badge!

    While active, the project documentation MUST have a policy that code collaborators are reviewed prior to granting escalated permissions to sensitive resources. [OSPS-GV-04.01]
    Publish an enforceable policy in the project documentation that requires code collaborators to be reviewed and approved before being granted escalated permissions to sensitive resources, such as merge approval or access to secrets. It is recommended that vetting includes establishing a justifiable lineage of identity such as confirming the contributor's association with a known trusted organization.

    MAINTAINERS.md (https://github.com/timlnx/bitmath/blob/master/MAINTAINERS.md) "Becoming a Maintainer" section documents the escalation path: prospective co-maintainers start by regularly landing reviewed contributions and graduate to write access only after trust is established. The current sole-maintainer access is enumerated explicitly.


    Enough for a badge!

    When the project has made a release, all compiled released software assets MUST be delivered with a software bill of materials. [OSPS-QA-02.02]
    It is recommended to auto-generate SBOMs at build time using a tool that has been vetted for accuracy. This enables users to ingest this data in a standardized approach alongside other projects in their environment.

    The publish.yml workflow (https://github.com/timlnx/bitmath/blob/master/.github/workflows/publish.yml) generates a CycloneDX SBOM via cyclonedx-py against the built wheel installed in an isolated venv, and attaches the resulting bitmath-<version>.cdx.json to the GitHub release alongside the wheel and sdist. Verification instructions are in VERIFICATION.md.


    Enough for a badge!

    When the project has made a release comprising multiple source code repositories, all subprojects MUST enforce security requirements that are as strict or stricter than the primary codebase. [OSPS-QA-04.02]
    Any additional subproject code repositories produced by the project and compiled into a release must enforce security requirements as applicable to the status and intent of the respective codebase. In addition to following the corresponding OSPS Baseline requirements, this may include requiring a security review, ensuring that it is free of vulnerabilities, and ensuring that it is free of known security issues.

    bitmath is a single-repository project with no subprojects compiled into the release.


    Enough for a badge!

    While active, project's documentation MUST clearly document when and how tests are run. [OSPS-QA-06.02]
    Add a section to the contributing documentation that explains how to run the tests locally and how to run the tests in the CI/CD pipeline. The documentation should explain what the tests are testing and how to interpret the results.

    The "Running the Tests", "Makefile Targets", and "Components" sections of the contributing guide (https://bitmath.readthedocs.io/en/latest/contributing.html) document how to run tests locally (make ci), how they run in CI (full Python 3.9–3.13 × {macOS, Ubuntu, Windows} matrix on every push and PR), what each tool checks, and how to interpret the results.


    Enough for a badge!

    While active, the project's documentation MUST include a policy that all major changes to the software produced by the project should add or update tests of the functionality in an automated test suite. [OSPS-QA-06.03]
    Add a section to the contributing documentation that explains the policy for adding or updating tests. The policy should explain what constitutes a major change and what tests should be added or updated.

    The "Testing Policy" section of the contributing guide (https://bitmath.readthedocs.io/en/latest/contributing.html#testing-policy) states with explicit MUST language that every major change to the library must be accompanied by tests in the same pull request, with a precise definition of what counts as a major change and what does not.


    Not enough for a badge.

    When a commit is made to the primary branch, the project's version control system MUST require at least one non-author human approval of the changes before merging. [OSPS-QA-07.01]
    Configure the project's version control system to require at least one non-author human approval of changes before merging into the release or primary branch. This can be achieved by requiring a pull request to be reviewed and approved by at least one other collaborator before it can be merged.

    bitmath is a single-maintainer project as documented in MAINTAINERS.md. Branch protection requires 18 status checks to pass and enforces them against admins, but there is structurally no second human available to provide non-author code review. This control will become satisfiable once a co-maintainer is in place; an open ask for a Debian/Ubuntu co-maintainer is tracked in https://github.com/timlnx/bitmath/issues/117.


    Enough for a badge!

    When the project has made a release, the project MUST perform a threat modeling and attack surface analysis to understand and protect against attacks on critical code paths, functions, and interactions within the system. [OSPS-SA-03.02]
    Threat modeling is an activity where the project looks at the codebase, associated processes and infrastructure, interfaces, key components and "thinks like a hacker" and brainstorms how the system be be broken or compromised. Each identified threat is listed out so the project can then think about how to proactively avoid or close off any gaps/vulnerabilities that could arise. Ensure this is updated for new features or breaking changes.

    SECURITY_ASSESSMENT.md (https://github.com/timlnx/bitmath/blob/master/SECURITY_ASSESSMENT.md) is the project's standing threat model, identifying attack surfaces in order of concern (parse_string, filesystem helpers, query_device_capacity, the build/release pipeline) with the mitigations in place at each. The document is reviewed at every minor release per its stated contract.


    Enough for a badge!

    While active, any vulnerabilities in the software components not affecting the project MUST be accounted for in a VEX document, augmenting the vulnerability report with non-exploitability details. [OSPS-VM-04.02]
    Establish a VEX feed communicating the exploitability status of known vulnerabilities, including assessment details or any mitigations in place preventing vulnerable code from being executed.

    bitmath has zero runtime dependencies (verifiable in pyproject.toml), so there are no third-party software components against which non-exploitability assessments need to be expressed. The project itself has no known vulnerabilities; the disclosure channel (GitHub Security Advisories) is configured for future use.


    Enough for a badge!

    While active, the project documentation MUST include a policy that defines a threshold for remediation of SCA findings related to vulnerabilities and licenses. [OSPS-VM-05.01]
    Document a policy in the project that defines a threshold for remediation of SCA findings related to vulnerabilities and licenses. Include the process for identifying, prioritizing, and remediating these findings.

    SECURITY_POLICIES.md (https://github.com/timlnx/bitmath/blob/master/SECURITY_POLICIES.md) defines CVSS-based remediation thresholds for SCA findings (Critical: 7 days, High: 30 days, Medium: 90 days, Low: best effort) along with a documented suppression rule for non-exploitable findings.


    Enough for a badge!

    While active, the project documentation MUST include a policy to address SCA violations prior to any release. [OSPS-VM-05.02]
    Document a policy in the project to address applicable Software Composition Analysis results before any release, and add status checks that verify compliance with that policy prior to release.

    SECURITY_POLICIES.md states that releases MUST NOT ship while a Critical or High SCA finding is unaddressed (unless formally suppressed as non-exploitable), and that the .github/workflows/sca.yml required status check enforces this on the merge path that gates releases.


    Enough for a badge!

    While active, all changes to the project's codebase MUST be automatically evaluated against a documented policy for malicious dependencies and known vulnerabilities in dependencies, then blocked in the event of violations, except when declared and suppressed as non-exploitable. [OSPS-VM-05.03]
    Create a status check in the project's version control system that runs a Software Composition Analysis tool on all changes to the codebase. Require that the status check passes before changes can be merged.

    The .github/workflows/sca.yml workflow runs pip-audit against requirements.txt on every push and pull request. The audit job is configured as a required status check on master in branch protection settings, so any finding blocks merging until resolved.


    Enough for a badge!

    While active, the project documentation MUST include a policy that defines a threshold for remediation of SAST findings. [OSPS-VM-06.01]
    Document a policy in the project that defines a threshold for remediation of Static Application Security Testing (SAST) findings. Include the process for identifying, prioritizing, and remediating these findings.

    SECURITY_POLICIES.md defines remediation thresholds for SAST findings from Bandit and CodeQL (High: 7 days for existing findings, immediate block for new ones; Medium: 30 days; Low: best effort) along with a suppression rule that requires an inline justification on any # nosec or # lgtm[] annotation.


    Enough for a badge!

    While active, all changes to the project's codebase MUST be automatically evaluated against a documented policy for security weaknesses and blocked in the event of violations except when declared and suppressed as non-exploitable. [OSPS-VM-06.02]
    Create a status check in the project's version control system that runs a Static Application Security Testing (SAST) tool on all changes to the codebase. Require that the status check passes before changes can be merged.

    Bandit (.github/workflows/bandit.yml) and CodeQL (.github/workflows/codeql.yml) are both in the 18 required status checks on master, so any High SAST finding from either tool blocks merging until resolved.



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Tim Case and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Tim Case.
Entry created on 2026-05-04 23:07:38 UTC, last updated on 2026-05-24 07:07:48 UTC. Last achieved passing badge on 2026-05-24 04:07:11 UTC.