tsoracle

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 badge status on your project page! The badge status looks like this: Badge level for project 12991 is passing Here is how to embed it:
You can show your badge status by embedding this in your markdown file:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/12991/badge)](https://www.bestpractices.dev/projects/12991)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/12991"><img src="https://www.bestpractices.dev/projects/12991/badge"></a>


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

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

        

 Basics 13/13

  • General

    Note that other projects may use the same name.

    Distributed Timestamp Oracle (TSO) for Rust

    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.
  • Basic project website content


    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]
    This MUST be in language that potential users can understand (e.g., it uses minimal jargon).

    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution]
    We presume that projects on GitHub use issues and pull requests unless otherwise noted. This information can be short, e.g., stating that the project uses pull requests, an issue tracker, or posts to a mailing list (which one?)

    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]

    https://github.com/prisma-risk/tsoracle/blob/main/CONTRIBUTING.md

    CONTRIBUTING.md documents the requirements for acceptable contributions and the project's coding standards. In particular:

    • Required CI checks ("Running the checks locally")
    • Coding standards
    • Proto changes must additionally pass buf lint, buf format, and buf breaking against the main baseline.
    • Supply-chain policy — cargo deny check enforces the license allow-list and advisory policy declared in deny.toml.
    • Commit-message standard — Conventional Commits prefixes (feat:, fix:, chore:, docs:, refactor:, test:, perf:), rebase-and-squash onto main before opening a
      PR.

  • FLOSS license


    The software produced by the project MUST be released as FLOSS. [floss_license]
    FLOSS is software released in a way that meets the Open Source Definition or Free Software Definition. Examples of such licenses include the CC0, MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). For our purposes, this means that the license MUST be: The software MAY also be licensed other ways (e.g., "GPLv2 or proprietary" is acceptable).

    The Apache-2.0 license is approved by the Open Source Initiative (OSI).
    https://github.com/prisma-risk/tsoracle/blob/main/LICENSE



    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 OSI uses a rigorous approval process to determine which licenses are OSS.

    The Apache-2.0 license is approved by the Open Source Initiative (OSI).
    https://github.com/prisma-risk/tsoracle/blob/main/LICENSE



    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]
    One convention is posting the license as a top-level file named LICENSE or COPYING, which MAY be followed by an extension such as ".txt" or ".md". An alternative convention is to have a directory named LICENSES containing license file(s); these files are typically named as their SPDX license identifier followed by an appropriate file extension, as described in the REUSE Specification. Note that this criterion is only a requirement on the source repository. You do NOT need to include the license file when generating something from the source code (such as an executable, package, or container). For example, when generating an R package for the Comprehensive R Archive Network (CRAN), follow standard CRAN practice: if the license is a standard license, use the standard short license specification (to avoid installing yet another copy of the text) and list the LICENSE file in an exclusion file such as .Rbuildignore. Similarly, when creating a Debian package, you may put a link in the copyright file to the license text in /usr/share/common-licenses, and exclude the license file from the created package (e.g., by deleting the file after calling dh_auto_install). We encourage including machine-readable license information in generated formats where practical.
  • Documentation


    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]
    This documentation must be in some media (such as text or video) that includes: how to install it, how to start it, how to use it (possibly with a tutorial using examples), and how to use it securely (e.g., what to do and what not to do) if that is an appropriate topic for the software. The security documentation need not be long. The project MAY use hypertext links to non-project material as documentation. If the project does not produce software, choose "not applicable" (N/A).

    Some documentation basics file contents found.



    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]
    The documentation of an external interface explains to an end-user or developer how to use it. This would include its application program interface (API) if the software has one. If it is a library, document the major classes/types and methods/functions that can be called. If it is a web application, define its URL interface (often its REST interface). If it is a command-line interface, document the parameters and options it supports. In many cases it's best if most of this documentation is automatically generated, so that this documentation stays synchronized with the software as it changes, but this isn't required. The project MAY use hypertext links to non-project material as documentation. Documentation MAY be automatically generated (where practical this is often the best way to do so). Documentation of a REST interface may be generated using Swagger/OpenAPI. Code interface documentation MAY be generated using tools such as JSDoc (JavaScript), ESDoc (JavaScript), pydoc (Python), devtools (R), pkgdown (R), and Doxygen (many). Merely having comments in implementation code is not sufficient to satisfy this criterion; there needs to be an easy way to see the information without reading through all the source code. If the project does not produce software, choose "not applicable" (N/A).
  • Other


    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]
    This requires that the project home page URL and the version control repository URL begin with "https:", not "http:". You can get free certificates from Let's Encrypt. Projects MAY implement this criterion using (for example) GitHub pages, GitLab pages, or SourceForge project pages. If you support HTTP, we urge you to redirect the HTTP traffic to 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]
    Examples of acceptable mechanisms include archived mailing list(s), GitHub issue and pull request discussions, Bugzilla, Mantis, and Trac. Asynchronous discussion mechanisms (like IRC) are acceptable if they meet these criteria; make sure there is a URL-addressable archiving mechanism. Proprietary JavaScript, while discouraged, is permitted.

    GitHub supports discussions on issues and pull requests.



    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]
    English is currently the lingua franca of computer technology; supporting English increases the number of different potential developers and reviewers worldwide. A project can meet this criterion even if its core developers' primary language is not English.


    The project MUST be maintained. [maintained]
    As a minimum, the project should attempt to respond to significant problem and vulnerability reports. A project that is actively pursuing a badge is probably maintained. All projects and people have limited resources, and typical projects must reject some proposed changes, so limited resources and proposal rejections do not by themselves indicate an unmaintained project.

    When a project knows that it will no longer be maintained, it should set this criterion to "Unmet" and use the appropriate mechanism(s) to indicate to others that it is not being maintained. For example, use “DEPRECATED” as the first heading of its README, add “DEPRECATED” near the beginning of its home page, add “DEPRECATED” to the beginning of its code repository project description, add a no-maintenance-intended badge in its README and/or home page, mark it as deprecated in any package repositories (e.g., npm deprecate), and/or use the code repository's marking system to archive it (e.g., GitHub's "archive" setting, GitLab’s "archived" marking, Gerrit's "readonly" status, or SourceForge’s "abandoned" project status). Additional discussion can be found here.

 Change Control 9/9

  • Public version-controlled source repository


    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]
    The URL MAY be the same as the project URL. The project MAY use private (non-public) branches in specific cases while the change is not publicly released (e.g., for fixing a vulnerability before it is revealed to the public).

    Repository on GitHub, which provides public git repositories with URLs.



    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.



    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]
    Projects MAY choose to omit specific interim versions from their public source repositories (e.g., ones that fix specific non-public security vulnerabilities, may never be publicly released, or include material that cannot be legally posted and are not in the final release).

    All development occurs in this public GitHub repository. Every commit between tagged releases is publicly visible on the main branch, and changes are landed via public pull requests that remain in the repository history. There is no private development fork; the public repo is the canonical source of truth.



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]
    Git is not specifically required and projects can use centralized version control software (such as subversion) with justification.

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


  • Unique version numbering


    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]
    This MAY be met in a variety of ways including a commit IDs (such as git commit id or mercurial changeset id) or a version number (including version numbers that use semantic versioning or date-based schemes like YYYYMMDD).

    Each published artifact has a unique SemVer identifier. The workspace publishes multiple crates to crates.io, and each crate is released under its own <crate-name>-v<MAJOR.MINOR.PATCH> git tag (e.g., tsoracle-v0.1.14, tsoracle-server-v0.2.9, tsoracle-driver-openraft-v0.3.3). The version in each crate's Cargo.toml matches its tag, so the version string a user sees via cargo or in a Cargo.lock uniquely identifies the released code state. Every release additionally has a unique git commit SHA on main.



    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]
    Projects should generally prefer whatever format is expected by their users, e.g., because it is the normal format used by their ecosystem. Many ecosystems prefer SemVer, and SemVer is generally preferred for application programmer interfaces (APIs) and software development kits (SDKs). CalVer tends to be used by projects that are large, have an unusually large number of independently-developed dependencies, have a constantly-changing scope, or are time-sensitive. It is SUGGESTED that those who use CalVer include a micro level value, because including a micro level supports simultaneously-maintained branches whenever that becomes necessary. Other version numbering formats may be used as version numbers, including git commit IDs or mercurial changeset IDs, as long as they uniquely identify versions. However, some alternatives (such as git commit IDs) can cause problems as release identifiers, because users may not be able to easily determine if they are up-to-date. The version ID format may be unimportant for identifying software releases if all recipients only run the latest version (e.g., it is the code for a single website or internet service that is constantly updated via continuous delivery).


    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]

  • 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]
    The release notes MAY be implemented in a variety of ways. Many projects provide them in a file named "NEWS", "CHANGELOG", or "ChangeLog", optionally with extensions such as ".txt", ".md", or ".html". Historically the term "change log" meant a log of every change, but to meet these criteria what is needed is a human-readable summary. The release notes MAY instead be provided by version control system mechanisms such as the GitHub Releases workflow.

    URL: https://github.com/prisma-risk/tsoracle/releases

    Release notes are published via the GitHub Releases workflow for every tagged version, and mirrored in per-crate CHANGELOG.md files under crates/*/CHANGELOG.md using the Keep a Changelog format with Added / Fixed / Other sections and PR links. They are generated by release-plz from Conventional Commits — i.e., curated human-readable summaries, not raw git log output. The repository is a Cargo workspace, so each published crate (binary, server, client, drivers, toolkits) has its own SemVer track and its own changelog entry per release.



    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]
    This criterion helps users determine if a given update will fix a vulnerability that is publicly known, to help users make an informed decision about updating. If users typically cannot practically update the software themselves on their computers, but must instead depend on one or more intermediaries to perform the update (as is often the case for a kernel and low-level software that is intertwined with a kernel), the project may choose "not applicable" (N/A) instead, since this additional information will not be helpful to those users. Similarly, a project may choose N/A if all recipients only run the latest version (e.g., it is the code for a single website or internet service that is constantly updated via continuous delivery). This criterion only applies to the project results, not its dependencies. Listing the vulnerabilities of all transitive dependencies of a project becomes unwieldy as dependencies increase and vary, and is unnecessary since tools that examine and track dependencies can do this in a more scalable way.

    No publicly known run-time vulnerability has ever been assigned a CVE or published as a GitHub Security Advisory against tsoracle. The repository's Security Advisories list (https://github.com/prisma-risk/tsoracle/security/advisories) is empty, and no CVE-* / GHSA-* identifier appears in any release's notes (https://github.com/prisma-risk/tsoracle/releases) or per-crate CHANGELOG.md. Per the criterion text, this case selects N/A. The project's SECURITY.md documents the private reporting channel so that when a vulnerability is reported and fixed, future release notes can identify it by CVE/GHSA.


 Reporting 8/8

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

    Non-trivial SECURITY[.md] file found file in repository: https://github.com/prisma-risk/tsoracle/blob/main/SECURITY.md. [osps_do_02_01]



    The project SHOULD use an issue tracker for tracking individual issues. [report_tracker]

    GitHub Issues is the project's issue tracker (https://github.com/prisma-risk/tsoracle/issues). It is publicly readable, supports anyone with a GitHub account filing new issues, supports labeling, milestones, assignment, cross-references to commits/PRs, and search across open and closed history.



    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]

    Bug reports and feature requests are tracked at https://github.com/prisma-risk/tsoracle/issues and responded to by the maintainer. Issues are triaged within days of being filed; the majority are resolved by a merged PR within weeks. The issue tracker is public, supports labeling, and links bidirectionally to commits and PRs.



    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]
    The response MAY be 'no' or a discussion about its merits. The goal is simply that there be some response to some requests, which indicates that the project is still alive. For purposes of this criterion, projects need not count fake requests (e.g., from spammers or automated systems). If a project is no longer making enhancements, please select "unmet" and include the URL that makes this situation clear to users. If a project tends to be overwhelmed by the number of enhancement requests, please select "unmet" and explain.

    Enhancement requests filed as GitHub Issues are responded to by the maintainer. Where an enhancement is accepted, a tracking issue or PR is opened; where rejected, the rationale is recorded on the issue thread. The issue tracker at https://github.com/prisma-risk/tsoracle/issues is the canonical channel.



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

    URL: https://github.com/prisma-risk/tsoracle/issues?q=is%3Aissue

    GitHub Issues serves as the public, permanent archive of bug reports, feature requests, and discussion. Closed issues remain visible and searchable; every issue has a stable URL. PRs are similarly archived at https://github.com/prisma-risk/tsoracle/pulls?q=is%3Apr.


  • Vulnerability report process


    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]
    Projects hosted on GitHub SHOULD consider enabling privately reporting a security vulnerability. Projects on GitLab SHOULD consider using its ability for privately reporting a vulnerability. Projects MAY identify a mailing address on https://PROJECTSITE/security, often in the form security@example.org. This vulnerability reporting process MAY be the same as its bug reporting process. Vulnerability reports MAY always be public, but many projects have a private vulnerability reporting mechanism.

    URL: https://github.com/prisma-risk/tsoracle/blob/main/SECURITY.md

    SECURITY.md documents the vulnerability reporting process end-to-end: where to file a report (private draft Security Advisory at https://github.com/prisma-risk/tsoracle/security/advisories/new — not public issues), what information to include (affected versions, impact assessment, minimal reproduction, severity estimate), the project's response commitments (24h acknowledgment, 72h triage, 30d coordinated disclosure or sooner on fix release), the in-scope and out-of-scope surface, and the post-fix public-disclosure flow with CVE request via the GitHub CNA.



    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]
    Examples include a private defect report submitted on the web using HTTPS (TLS) or an email encrypted using OpenPGP. If vulnerability reports are always public (so there are never private vulnerability reports), choose "not applicable" (N/A).

    URL: https://github.com/prisma-risk/tsoracle/security/advisories/new

    The project's SECURITY.md directs reporters to GitHub's private Security Advisories channel, which is encrypted in transit (TLS) and visible only to repository maintainers. SECURITY.md additionally invites reporters to request an out-of-band encrypted channel via a follow-up comment on the advisory if they need stronger pre-disclosure secrecy.



    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]
    If there have been no vulnerabilities reported in the last 6 months, choose "not applicable" (N/A).

    No vulnerability reports have been received against tsoracle to date. The project's Security Advisories list (https://github.com/prisma-risk/tsoracle/security/advisories) contains zero advisories, draft or published. When a report is received, SECURITY.md commits the project to acknowledgment within 24 hours and triage within 72 hours; the criterion will become demonstrably Met after the first report is responded to within those windows.


 Quality 13/13

  • 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]
    A build system determines what actions need to occur to rebuild the software (and in what order), and then performs those steps. For example, it can invoke a compiler to compile the source code. If an executable is created from source code, it must be possible to modify the project's source code and then generate an updated executable with those modifications. If the software produced by the project depends on external libraries, the build system does not need to build those external libraries. If there is no need to build anything to use the software after its source code is modified, select "not applicable" (N/A).

    Non-trivial build file in repository: https://github.com/prisma-risk/tsoracle/blob/main/Makefile.



    It is SUGGESTED that common tools be used for building the software. [build_common_tools]
    For example, Maven, Ant, cmake, the autotools, make, rake (Ruby), or devtools (R).

    Non-trivial build file in repository: https://github.com/prisma-risk/tsoracle/blob/main/Makefile.



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

    The build uses cargo and the rustc Rust compiler — both released under the FLOSS dual MIT/Apache-2.0 license (https://github.com/rust-lang/rust/blob/master/COPYRIGHT). Supporting build-time tools enforced by CI (protoc, buf, clang/libclang, cargo-llvm-cov, cargo-deny) are all FLOSS. No proprietary tooling is required to build the project from source.


  • 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]
    The project MAY use multiple automated test suites (e.g., one that runs quickly, vs. another that is more thorough but requires special equipment). There are many test frameworks and test support systems available, including Selenium (web browser automation), Junit (JVM, Java), RUnit (R), testthat (R).

    .github/workflows/ci.yml runs cargo test --workspace --all-features --locked on every push and PR, covering unit tests in each of the 17 workspace crates, integration tests under crates/*/tests/ (monotonicity, single_node, three_node, snapshot_transfer, restart_replay, linearized_barrier, reconfiguration, dynamic_membership, and ~20 more), plus the failpoints (docs/failpoint-testing.md) and yieldpoints (docs/yieldpoint-testing.md) feature suites. A cross-platform driver-file job runs on Ubuntu, macOS, and Windows. Out-of-process: 15+ libFuzzer harnesses (fuzz/fuzz_targets/), the kube-e2e and mixed-version-soak Kubernetes acceptance lanes (kube-e2e.yml, kube-e2e-mixed-version.yml), the stress-smoke PR job (mem/raft/paxos/process topologies with a positive-control inject-violation step), and nightly leak/fuzz/stress workflows.



    A test suite SHOULD be invocable in a standard way for that language. [test_invocation]
    For example, "make check", "mvn test", or "rake test" (Ruby).

    URL: https://github.com/prisma-risk/tsoracle/blob/main/CONTRIBUTING.md

    The project's tests are invoked with cargo test --workspace --all-features (documented under 'Running the checks locally' in CONTRIBUTING.md). The Makefile additionally provides convenience targets such as make test-failpoints and make coverage.



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

    Coverage is measured by cargo-llvm-cov in the coverage CI job and uploaded to Coveralls (https://coveralls.io/github/prisma-risk/tsoracle). The most recent measurement is approximately 95% line coverage across the workspace, indicating that most major functionality is exercised by automated tests. Critical paths (consensus drivers, timestamp allocator, leader handoff) are covered by dedicated integration test files and additionally by fuzz harnesses for input-decoder paths.



    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]

    URL: https://github.com/prisma-risk/tsoracle/blob/main/.github/workflows/ci.yml

    CI runs on every push to main and every pull request via .github/workflows/ci.yml. Jobs: test (full workspace), cross-platform driver-file (ubuntu/macOS/Windows), buf (proto lint/format/breaking), deny, critical-path, header-check, fuzz-lockfile, coverage, stress-smoke. Additional workflows trigger on schedule or specific paths: fuzz-pr.yml (per-PR), fuzz-nightly.yml, kube-e2e.yml, kube-e2e-mixed-version.yml, leak-nightly.yml, stress-nightly.yml, scorecard.yml, release-plz.yml, release-images.yml, pages-build-check.yml, pages.yml.


  • 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]
    As long as a policy is in place, even by word of mouth, that says developers should add tests to the automated test suite for major new functionality, select "Met."

    URL: https://github.com/prisma-risk/tsoracle/blob/main/CONTRIBUTING.md#test-policy
    CONTRIBUTING.md has an explicit ## Test policy section requiring that every contribution adding new functionality MUST include automated tests exercising it, and every bug fix MUST include at least one regression test that fails on the unfixed code and passes on the fix. Tests run via cargo test --workspace --all-features as a CI required check. Exempt: docs:, refactor:, chore: Conventional Commits prefixes (no runtime behavior change). Enforced at review time, backed by measured workspace line coverage (cargo-llvm-cov → Coveralls, currently ~95%).



    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]
    Major functionality would typically be mentioned in the release notes. Perfection is not required, merely evidence that tests are typically being added in practice to the automated test suite when new major functionality is added to the software produced by the project.

    Recent commit history on the main branch (https://github.com/prisma-risk/tsoracle/commits/main) shows that non-trivial code changes are typically accompanied by tests. Examples from recent months: barrier-seq durable seed (M5), snapshot publish TOCTOU (M4), WatchGuard drop sync stepdown (M3), shutdown stall on hung driver (M2), paxos lease generation wrap, openraft peer RPC deadline — each shipped with the regression test that proved the fix. The CI required-checks gate prevents fixes from landing without tests at the architectural level the change touched.



    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]
    However, even an informal rule is acceptable as long as the tests are being added in practice.

    Same gap as test_policy: CONTRIBUTING.md does not yet explicitly require new functionality to be accompanied by tests. The de-facto practice is consistent (see tests_are_added at the passing level), but the policy is not documented. Action: add a one-sentence policy to CONTRIBUTING.md.


  • 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]
    Examples of compiler warning flags include gcc/clang "-Wall". Examples of a "safe" language mode include JavaScript "use strict" and perl5's "use warnings". A separate "linter" tool is simply a tool that examines the source code to look for code quality errors or common simple mistakes. These are typically enabled within the source code or build instructions.

    The project enables compiler warnings via cargo's default warning set, and Clippy lints — the canonical Rust linter — are run in CI with cargo clippy --workspace --all-targets --all-features --locked -- -D warnings (see .github/workflows/ci.yml). The -D warnings flag promotes every warning to a hard error, so any warning in any workspace crate fails CI. Library and binary crates additionally carry #![cfg_attr(not(test), warn(clippy::unwrap_used, clippy::expect_used))] at the crate root to flag panicking calls in non-test code (documented in CONTRIBUTING.md).



    The project MUST address warnings. [warnings_fixed]
    These are the warnings identified by the implementation of the warnings criterion. The project should fix warnings or mark them in the source code as false positives. Ideally there would be no warnings, but a project MAY accept some warnings (typically less than 1 warning per 100 lines or less than 10 warnings).

    Because clippy runs with -D warnings in CI as a required check, no PR can merge into main with an outstanding warning. The workspace contains no #![allow] overrides at the workspace or crate level for lint groups. The pre-commit hook in .husky/pre-commit additionally runs fmt + clippy locally before commit, surfacing warnings before they reach CI.



    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]
    Some warnings cannot be effectively enabled on some projects. What is needed is evidence that the project is striving to enable warning flags where it can, so that errors are detected early.

    The project's CI runs cargo clippy --workspace --all-targets --all-features --locked -- -D warnings, treating every warning as a hard error. Library and binary crates additionally carry #![cfg_attr(not(test), warn(clippy::unwrap_used, clippy::expect_used))] to escalate panicking patterns in non-test code. No #![allow] overrides are present at the workspace level, and no workarounds (e.g., clippy.toml allow-unwrap-in-tests) are used to silence the lint.


 Security 16/16

  • 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]
    This requires understanding the following design principles, including the 8 principles from Saltzer and Schroeder:
    • economy of mechanism (keep the design as simple and small as practical, e.g., by adopting sweeping simplifications)
    • fail-safe defaults (access decisions should deny by default, and projects' installation should be secure by default)
    • complete mediation (every access that might be limited must be checked for authority and be non-bypassable)
    • open design (security mechanisms should not depend on attacker ignorance of its design, but instead on more easily protected and changed information like keys and passwords)
    • separation of privilege (ideally, access to important objects should depend on more than one condition, so that defeating one protection system won't enable complete access. E.G., multi-factor authentication, such as requiring both a password and a hardware token, is stronger than single-factor authentication)
    • least privilege (processes should operate with the least privilege necessary)
    • least common mechanism (the design should minimize the mechanisms common to more than one user and depended on by all users, e.g., directories for temporary files)
    • psychological acceptability (the human interface must be designed for ease of use - designing for "least astonishment" can help)
    • limited attack surface (the attack surface - the set of the different points where an attacker can try to enter or extract data - should be limited)
    • input validation with allowlists (inputs should typically be checked to determine if they are valid before they are accepted; this validation should use allowlists (which only accept known-good values), not denylists (which attempt to list known-bad values)).
    A "primary developer" in a project is anyone who is familiar with the project's code base, is comfortable making changes to it, and is acknowledged as such by most other participants in the project. A primary developer would typically make a number of contributions over the past year (via code, documentation, or answering questions). Developers would typically be considered primary developers if they initiated the project (and have not left the project more than three years ago), have the option of receiving information on a private vulnerability reporting channel (if there is one), can accept commits on behalf of the project, or perform final releases of the project software. If there is only one developer, that individual is the primary developer. Many books and courses are available to help you understand how to develop more secure software and discuss design. For example, the Secure Software Development Fundamentals course is a free set of three courses that explain how to develop more secure software (it's free if you audit it; for an extra fee you can earn a certificate to prove you learned the material).

    At least one project member is familiar with secure design principles, demonstrated by concrete decisions: (1) TLS/mTLS on peer and admin transport, with a secure-by-default Helm chart guard that refuses to render an HA openraft/paxos deployment without TLS unless tls.allowInsecurePeer=true is set explicitly; (2) fail-closed defaults across the consensus/timestamp critical path (single-active leadership-stream lease, synchronous WatchGuard step-down at the drop site, openraft graceful handoff transferring leadership before drain); (3) defense-in-depth on the client (per-pass + absolute redirect caps, MAX_TOTAL_LEADER_REDIRECTS=64); (4) SECURITY.md with the report→triage→CNA-coordinated CVE disclosure flow; (5) input validation at the gRPC decode boundary backed by 15+ libFuzzer harnesses.



    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]
    Examples (depending on the type of software) include SQL injection, OS injection, classic buffer overflow, cross-site scripting, missing authentication, and missing authorization. See the CWE/SANS top 25 or OWASP Top 10 for commonly used lists. Many books and courses are available to help you understand how to develop more secure software and discuss common implementation errors that lead to vulnerabilities. For example, the Secure Software Development Fundamentals course is a free set of three courses that explain how to develop more secure software (it's free if you audit it; for an extra fee you can earn a certificate to prove you learned the material).

    At least one project member is familiar with common errors leading to vulnerabilities. The implementation language is safe Rust, which structurally excludes the memory-safety class (buffer overflow, use-after-free, double-free, data races on Send/Sync types). For classes Rust does not prevent: (1) 15+ libFuzzer harnesses (fuzz/fuzz_targets/) exercise codec/proto decode paths against malformed input, run per-PR and nightly with auto-issue filing on crash; (2) cargo-deny enforces a FLOSS-only license allow-list and the RustSec advisory database in the deny CI job; (3) OpenSSF Scorecard runs on every push and weekly cron; (4) Dependabot updates GitHub Actions, the fuzz workspace, and base image digests; (5) base images pinned by SHA256 in deploy/Dockerfile.


  • 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]
    These cryptographic criteria do not always apply because some software has no need to directly use cryptographic capabilities.

    The project does not implement cryptographic algorithms itself. Where it uses cryptography (TLS for the gRPC client/server and peer transport), it relies on rustls via tonic, which uses the published ring / aws-lc-rs providers exercising standardized algorithms documented by IETF RFCs (TLS 1.3 cipher suites, ECDSA, RSA-PKCS#1, X25519, AES-GCM, ChaCha20-Poly1305).



    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]

    The project does not implement cryptography itself and does not expose cryptographic algorithm selection to its users as a tunable surface. Cryptographic choices are delegated to rustls/tonic defaults (modern TLS 1.3 cipher suites). The criterion applies to projects that select among multiple cryptographic algorithms at the application layer; tsoracle does not.



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

    All cryptographic implementations the project depends on are FLOSS: rustls (Apache-2.0/MIT/ISC), ring (ISC with a mixed-license historical statement), tonic (MIT). The cargo-deny deny.toml license allow-list (Apache-2.0, MIT, BSD-3-Clause, ISC, Unicode-3.0, Zlib) is enforced in CI and would reject a non-FLOSS crypto dependency on the next PR.



    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]
    These minimum bitlengths are: symmetric key 112, factoring modulus 2048, discrete logarithm key 224, discrete logarithmic group 2048, elliptic curve 224, and hash 224 (password hashing is not covered by this bitlength, more information on password hashing can be found in the crypto_password_storage criterion). See https://www.keylength.com for a comparison of keylength recommendations from various organizations. The software MAY allow smaller keylengths in some configurations (ideally it would not, since this allows downgrade attacks, but shorter keylengths are sometimes necessary for interoperability).

    The project uses TLS 1.3 via rustls defaults, which selects key lengths providing at least 128-bit security (X25519 with curve25519 / P-256 / RSA-2048 minimum / AES-128-GCM / AES-256-GCM / ChaCha20-Poly1305). The project does not implement its own crypto with sub-112-bit-security algorithms.



    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]
    ECB mode is almost never appropriate because it reveals identical blocks within the ciphertext as demonstrated by the ECB penguin, and CTR mode is often inappropriate because it does not perform authentication and causes duplicates if the input state is repeated. In many cases it's best to choose a block cipher algorithm mode designed to combine secrecy and authentication, e.g., Galois/Counter Mode (GCM) and EAX. Projects MAY allow users to enable broken mechanisms (e.g., during configuration) where necessary for compatibility, but then users know they're doing it.

    The project uses TLS 1.3 via rustls defaults. The rustls default profile rejects TLS 1.0/1.1 and weak/broken cipher suites (MD5 signature algorithms, RC4, DES/3DES, NULL ciphers, export-grade key exchange). The project does not use known-broken algorithms anywhere in its own source.



    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]
    Concerns about CBC mode in SSH are discussed in CERT: SSH CBC vulnerability.

    The project does not implement cryptographic algorithms; it consumes rustls via tonic. Rustls maintains its own cipher-suite hygiene upstream — no SHA-1 in signature contexts, no RC4, no DES/3DES, no 64-bit block ciphers, no TLS 1.0/1.1, no insecure curves — and tsoracle inherits those choices via the rustls default ClientConfig/ServerConfig.



    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]

    TLS 1.3 — the only protocol version rustls offers by default for tsoracle's transports — mandates ephemeral Diffie-Hellman key exchange (X25519 / secp256r1 / secp384r1) for every handshake, so perfect forward secrecy is provided for every session.



    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]
    This criterion applies only when the software is enforcing authentication of users using passwords for external users (aka inbound authentication), such as server-side web applications. It does not apply in cases where the software stores passwords for authenticating into other systems (aka outbound authentication, e.g., the software implements a client for some other system), since at least parts of that software must have often access to the unhashed password.

    The project does not authenticate users by password. Authentication between peers and between clients and the server is via mutual TLS (X.509 certificates), not passwords. No user-supplied secret is stored or compared by the project.



    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]
    A cryptographically secure random number generator may be a hardware random number generator, or it may be a cryptographically secure pseudo-random number generator (CSPRNG) using an algorithm such as Hash_DRBG, HMAC_DRBG, CTR_DRBG, Yarrow, or Fortuna. Examples of calls to secure random number generators include Java's java.security.SecureRandom and JavaScript's window.crypto.getRandomValues. Examples of calls to insecure random number generators include Java's java.util.Random and JavaScript's Math.random.

    The project uses the rand crate (workspace pin: rand = { version = '0.9', default-features = false, features = ['std', 'std_rng'] }) where std_rng is ChaCha12Rng, a cryptographically-secure PRNG, seeded via the getrandom crate from the OS CSPRNG (/dev/urandom, getrandom(2), BCryptGenRandom per platform). For TLS, rustls uses its provider's CSPRNG (ring/aws-lc-rs). The project does not use thread_rng() in security-critical paths and does not implement its own PRNG.


  • 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]
    An even stronger mechanism is releasing the software with digitally signed packages, since that mitigates attacks on the distribution system, but this only works if the users can be confident that the public keys for signatures are correct and if the users will actually check the signature.

    Distribution channels use HTTPS exclusively. [osps_br_03_02]



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

    Distributed artifacts include cryptographic integrity protection: (1) crates.io tarballs are referenced by SHA-256 in any consumer's Cargo.lock, so a transport-level tamper would change the consumer's lockfile; (2) container images on ghcr.io are content-addressable by SHA256 digest, and the project's deploy/Dockerfile pins base images by digest (FROM rust:1-bookworm@sha256:6258907abe... and FROM debian:bookworm-slim@sha256:0104b334...); (3) GitHub release tags are immutable git references identified by SHA-1 commit; (4) distribution channels themselves are HTTPS-only (see delivery_mitm).


  • 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]
    The vulnerability must be patched and released by the project itself (patches may be developed elsewhere). A vulnerability becomes publicly known (for this purpose) once it has a CVE with publicly released non-paywalled information (reported, for example, in the National Vulnerability Database) or when the project has been informed and the information has been released to the public (possibly by the project). A vulnerability is considered medium or higher severity if its Common Vulnerability Scoring System (CVSS) base qualitative score is medium or higher. In CVSS versions 2.0 through 3.1, this is equivalent to a CVSS score of 4.0 or higher. Projects may use the CVSS score as published in a widely-used vulnerability database (such as the National Vulnerability Database) using the most-recent version of CVSS reported in that database. Projects may instead calculate the severity themselves using the latest version of CVSS at the time of the vulnerability disclosure, if the calculation inputs are publicly revealed once the vulnerability is publicly known. Note: this means that users might be left vulnerable to all attackers worldwide for up to 60 days. This criterion is often much easier to meet than what Google recommends in Rebooting responsible disclosure, because Google recommends that the 60-day period start when the project is notified even if the report is not public. Also note that this badge criterion, like other criteria, applies to the individual project. Some projects are part of larger umbrella organizations or larger projects, possibly in multiple layers, and many projects feed their results to other organizations and projects as part of a potentially-complex supply chain. An individual project often cannot control the rest, but an individual project can work to release a vulnerability patch in a timely way. Therefore, we focus solely on the individual project's response time. Once a patch is available from the individual project, others can determine how to deal with the patch (e.g., they can update to the newer version or they can apply just the patch as a cherry-picked solution).

    No publicly known vulnerability has been disclosed against tsoracle to date — the project's Security Advisories list (https://github.com/prisma-risk/tsoracle/security/advisories) contains zero advisories, draft or published, and no CVE has been assigned. Therefore there has been no past instance where the 60-day clock could be either met or missed. The project's SECURITY.md commits to coordinated disclosure within 30 days from report (or sooner on fix release), well inside the 60-day criterion.



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

    No critical vulnerability has been publicly disclosed against tsoracle. SECURITY.md commits the project to coordinated disclosure within 30 days and to requesting a CVE via the GitHub CNA when the impact warrants one.


  • 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]
    A project MAY leak "sample" credentials for testing and unimportant databases, as long as they are not intended to limit public access.

    A grep of the repository for common secret patterns (BEGIN PRIVATE KEY, BEGIN RSA PRIVATE KEY, BEGIN OPENSSH PRIVATE KEY, AKIA[0-9A-Z]{16}, ghp_, aws_access_key) across .rs, .toml, .yml, and .md files returns zero matches. The only TLS/PKI material in the repository is test-only certificate generation via the rcgen crate at test-fixture time; no static private keys are committed. .gitignore excludes typical credential paths, and OpenSSF Scorecard's pinned-dependencies / token-permissions checks run on every push.


 Analysis 8/8

  • 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]
    A static code analysis tool examines the software code (as source code, intermediate code, or executable) without executing it with specific inputs. For purposes of this criterion, compiler warnings and "safe" language modes do not count as static code analysis tools (these typically avoid deep analysis because speed is vital). Some static analysis tools focus on detecting generic defects, others focus on finding specific kinds of defects (such as vulnerabilities), and some do a combination. Examples of such static code analysis tools include cppcheck (C, C++), clang static analyzer (C, C++), SpotBugs (Java), FindBugs (Java) (including FindSecurityBugs), PMD (Java), Brakeman (Ruby on Rails), lintr (R), goodpractice (R), Coverity Quality Analyzer, SonarQube, Codacy, and HP Enterprise Fortify Static Code Analyzer. Larger lists of tools can be found in places such as the Wikipedia list of tools for static code analysis, OWASP information on static code analysis, NIST list of source code security analyzers, and Wheeler's list of static analysis tools. If there are no FLOSS static analysis tools available for the implementation language(s) used, you may select 'N/A'.

    Three static-analysis categories run on every push and PR (.github/workflows/ci.yml): (1) Clippy with cargo clippy --workspace --all-targets --all-features --locked -- -D warnings denying every warning; (2) cargo-deny with cargo deny check enforces the FLOSS-only license allow-list (deny.toml) and the RustSec advisory database against the resolved dependency tree; (3) OpenSSF Scorecard supply-chain analysis (.github/workflows/scorecard.yml). Two project-specific guards also run: scripts/check-critical-path.sh (no tracing!/println!/sync-I/O on hot-path files) and scripts/check-ts-header.py (canonical Apache-2.0 short license header).



    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]
    Static analysis tools that are specifically designed to look for common vulnerabilities are more likely to find them. That said, using any static tools will typically help find some problems, so we are suggesting but not requiring this for the 'passing' level badge.

    OpenSSF Scorecard (.github/workflows/scorecard.yml) flags supply-chain and project-management common-vulnerability classes (token permissions, branch protection, pinned dependencies, dangerous workflow patterns). cargo-deny (.github/workflows/ci.yml deny job) checks the RustSec advisory database for known CVEs in the dependency graph on every PR. Clippy's default lint set includes lints for common error classes that Rust does not prevent at compile time (uninit reads, panicking calls in non-test code via the unwrap_used/expect_used escalation).



    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]
    A vulnerability is considered medium or higher severity if its Common Vulnerability Scoring System (CVSS) base qualitative score is medium or higher. In CVSS versions 2.0 through 3.1, this is equivalent to a CVSS score of 4.0 or higher. Projects may use the CVSS score as published in a widely-used vulnerability database (such as the National Vulnerability Database) using the most-recent version of CVSS reported in that database. Projects may instead calculate the severity themselves using the latest version of CVSS at the time of the vulnerability disclosure, if the calculation inputs are publicly revealed once the vulnerability is publicly known. Note that criterion vulnerabilities_fixed_60_days requires that all such vulnerabilities be fixed within 60 days of being made public.

    Because clippy runs with -D warnings (denying every warning to error) and the deny / header-check / critical-path guards are all required CI gates, no PR can merge with an outstanding static-analysis finding. The workspace contains no global #![allow] overrides on lint groups.



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

    Static analysis runs on every push to main and every pull request (see the clippy, deny, header-check, and critical-path jobs in .github/workflows/ci.yml — triggered by on: push: branches: [main] and on: pull_request). OpenSSF Scorecard runs additionally on a weekly cron (43 18 * * 6 in .github/workflows/scorecard.yml) and on every main-branch push.


  • 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]
    A dynamic analysis tool examines the software by executing it with specific inputs. For example, the project MAY use a fuzzing tool (e.g., American Fuzzy Lop) or a web application scanner (e.g., OWASP ZAP or w3af). In some cases the OSS-Fuzz project may be willing to apply fuzz testing to your project. For purposes of this criterion the dynamic analysis tool needs to vary the inputs in some way to look for various kinds of problems or be an automated test suite with at least 80% branch coverage. The Wikipedia page on dynamic analysis and the OWASP page on fuzzing identify some dynamic analysis tools. The analysis tool(s) MAY be focused on looking for security vulnerabilities, but this is not required.

    The project runs multiple dynamic-analysis modes: (1) libFuzzer harnesses in fuzz/fuzz_targets/ (15+ targets) running per-PR (.github/workflows/fuzz-pr.yml) and nightly (.github/workflows/fuzz-nightly.yml) with auto-issue filing on crash; (2) Kubernetes e2e in real cluster lanes (kube-e2e.yml, mixed-version-soak); (3) stress lanes with monotonicity assertion and positive-control inject-violation step (stress-smoke and stress-nightly.yml); (4) leak-nightly (.github/workflows/leak-nightly.yml) for memory leaks; (5) failpoint and yieldpoint test scaffolding for software-fault injection during integration runs.



    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]
    Examples of mechanisms to detect memory safety problems include Address Sanitizer (ASAN) (available in GCC and LLVM), Memory Sanitizer, and valgrind. Other potentially-used tools include thread sanitizer and undefined behavior sanitizer. Widespread assertions would also work.

    Where the project uses dynamic analysis (libFuzzer in fuzz/, kube-e2e + mixed-version-soak in e2e/kube/, stress-smoke + stress-nightly, leak-nightly), it exercises the program against malformed or adversarial input and under real-world fault injection. The failpoints and yieldpoints test scaffolding (see docs/failpoint-testing.md and docs/yieldpoint-testing.md) injects software faults during integration runs, and the stress lane's positive-control inject-violation step proves the monotonicity-violation detector still fires. Findings are addressed before merge.



    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]
    This criterion does not suggest enabling assertions during production; that is entirely up to the project and its users to decide. This criterion's focus is instead to improve fault detection during dynamic analysis before deployment. Enabling assertions in production use is completely different from enabling assertions during dynamic analysis (such as testing). In some cases enabling assertions in production use is extremely unwise (especially in high-integrity components). There are many arguments against enabling assertions in production, e.g., libraries should not crash callers, their presence may cause rejection by app stores, and/or activating an assertion in production may expose private data such as private keys. Beware that in many Linux distributions NDEBUG is not defined, so C/C++ assert() will by default be enabled for production in those environments. It may be important to use a different assertion mechanism or defining NDEBUG for production in those environments.

    Rust's debug_assert! macros are active in debug builds (default for cargo test) and in stress-smoke, kube-e2e, and fuzz harness binaries (libFuzzer builds in debug). The project uses debug_assert! liberally on invariant-protection paths (e.g., the openraft LeaderState contract guard at run_leader_watch, the PaxosRunner start guard, the consensus barrier-seq invariants).



    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]
    If you are not running dynamic code analysis and thus have not found any vulnerabilities in this way, choose "not applicable" (N/A). A vulnerability is considered medium or higher severity if its Common Vulnerability Scoring System (CVSS) base qualitative score is medium or higher. In CVSS versions 2.0 through 3.1, this is equivalent to a CVSS score of 4.0 or higher. Projects may use the CVSS score as published in a widely-used vulnerability database (such as the National Vulnerability Database) using the most-recent version of CVSS reported in that database. Projects may instead calculate the severity themselves using the latest version of CVSS at the time of the vulnerability disclosure, if the calculation inputs are publicly revealed once the vulnerability is publicly known.

    All medium-or-higher dynamic-analysis findings are fixed and gated on main: (1) libFuzzer harnesses in fuzz/fuzz_targets/ run per-PR (fuzz-pr.yml) and nightly with a 30-minute/target budget (fuzz-nightly.yml), crashes auto-file as issues with the offending input; (2) kube-e2e and mixed-version-soak (kube-e2e.yml, kube-e2e-mixed-version.yml) gate on a 0.05% soak error budget; (3) stress-smoke runs mem/raft/paxos/process topologies with a positive-control inject-violation step that must exit 1 to prove the supervisor still catches monotonicity breaks; (4) leak-nightly (leak-nightly.yml) runs nightly. None report unresolved findings on main.



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

Project badge entry owned by: Sebastian Thiebaud.
Entry created on 2026-05-26 18:53:24 UTC, last updated on 2026-05-26 22:21:27 UTC. Last achieved passing badge on 2026-05-26 22:21:27 UTC.