sipnab

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 13931 is baseline-3 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/13931/baseline)](https://www.bestpractices.dev/projects/13931)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/13931"><img src="https://www.bestpractices.dev/projects/13931/baseline"></a>


These are the Baseline Level 2 criteria. These are criteria version v2026.08.28.

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

        

 Basics

  • General

    Note that other projects may use the same name.

    sipnab is a SIP and RTP capture, analysis, and security tool for VoIP networks. It unifies sngrep (interactive TUI) and sipgrep (CLI) into a single Rust binary, adding first-class RTP quality monitoring (jitter, loss, MOS), VoIP diagnostic aliases, TLS/SRTP decryption, and security analysis (scanner, flood and fraud detection, STIR/SHAKEN). It also runs as an MCP server so an AI agent can drive it. Its only runtime dependency is libpcap.

    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.

    sipnab is under active development and not yet recommended for production use (the README states this). Despite the pre-1.0 status, it enforces a strict quality bar: more than 10,000 automated tests (10,468 at v0.5.196) run in CI on every push; Clippy and CodeQL gate every merge on a deny-on-warning basis; 19 fuzz targets cover every attacker-controlled parser and run daily under AddressSanitizer via ClusterFuzzLite, with ThreadSanitizer weekly over the threaded paths; releases ship with sigstore build provenance and CycloneDX SBOMs; and the tool is validated against a real-traffic pcap corpus. SECURITY.md documents the security model, including privilege drop, chroot and the scope of reportable issues.

    One note for reviewers of the crypto criteria: sipnab decrypts SIP and RTP that other systems encrypted, so it must interoperate with whatever algorithm a capture used. Vetted "weak" algorithms may therefore appear where reading an existing capture requires them — the project does not choose weak cryptography for its own protection.

 Controls 19/19 ●

  • Controls


    Enough for a badge!

    When a CI/CD task is executed with no permissions specified, the CI/CD system MUST default the task's permissions to the lowest permissions granted in the pipeline. [OSPS-AC-04.01]
    Configure the project's settings to assign the lowest available permissions to new pipelines by default, granting additional permissions only when necessary for specific tasks.

    https://github.com/NormB/sipnab/tree/main/.github/workflows

    ▎ The repository's Actions settings default the GITHUB_TOKEN to the lowest permission: default_workflow_permissions is read (read-only) and can_approve_pull_request_reviews is false, so any CI/CD task run with no permissions: specified receives read-only access. In addition, every workflow in .github/workflows/ declares an explicit least-privilege permissions: block — most are top-level contents: read; scorecard.yml uses permissions: {} (no permissions); and workflows that need more, such as pages.yml, grant only the specific scopes required (pages: write, id-token: write) rather than blanket write access. See https://github.com/NormB/sipnab/tree/main/.github/workflows .


    Enough for a badge!

    When an official release is created, that release MUST be assigned a unique version identifier. [OSPS-BR-02.01]
    Assign a unique version identifier to each release produced by the project, following a consistent naming convention or numbering scheme. Examples include SemVer, CalVer, or git commit id.

    Unique crate version, currently 0.5.83. [version_unique]


    Enough for a badge!

    When an official release is created, that release MUST contain a descriptive log of functional and security modifications. [OSPS-BR-04.01]
    Ensure that all releases include a descriptive change log. It is recommended to ensure that the change log is human-readable and includes details beyond commit messages, such as descriptions of the security impact or relevance to different use cases. To ensure machine readability, place the content under a markdown header such as "## Changelog".

    Non-trivial release notes file in repository: https://github.com/NormB/sipnab/blob/main/CHANGELOG.md. [release_notes]


    Enough for a badge!

    When a build and release pipeline ingests dependencies, it MUST use standardized tooling where available. [OSPS-BR-05.01]
    Use a common tooling for your ecosystem, such as package managers or dependency management tools to ingest dependencies at build time. This may include using a dependency file, lock file, or manifest to specify the required dependencies, which are then pulled in by the build system.

    Dependencies are ingested only through Cargo, Rust's standard tooling, from crates.io, resolved and pinned by the committed Cargo.lock. cargo-deny (deny.toml) enforces license, source and advisory policy, cargo-audit and OSV-Scanner check for advisories, and Dependabot proposes updates. CI actions are pinned to full commit SHAs.


    Enough for a badge!

    When an official release is created, that release MUST be signed or accounted for in a signed manifest including each asset's cryptographic hashes. [OSPS-BR-06.01]
    Sign all released software assets at build time with a cryptographic signature or attestations, such as GPG or PGP signature, Sigstore signatures, SLSA provenance, or SLSA VSAs. Include the cryptographic hashes of each asset in a signed manifest or metadata file.

    Every release artifact has a sigstore build-provenance attestation, generated in release.yml via GitHub artifact attestations (OIDC, keyless) and verifiable with gh attestation verify, plus SHA-256 checksums and CycloneDX SBOMs. crates.io publishing uses OIDC trusted publishing from the same tag-triggered workflow.


    Enough for a badge!

    When the project has made a release, the project documentation MUST include a description of how the project selects, obtains, and tracks its dependencies. [OSPS-DO-06.01]
    It is recommended to publish this information alongside the project's technical & design documentation on a publicly viewable resource such as the source code repository, project website, or other channel.

    The Dependencies section of CONTRIBUTING.md explains how new crates are chosen (license allowlist, crates.io only, no open advisories) and how they are tracked: Cargo.lock, cargo-audit and cargo-deny in CI, OSV-Scanner and Dependabot: https://github.com/NormB/sipnab/blob/main/CONTRIBUTING.md#dependencies


    Enough for a badge!

    The project documentation MUST include instructions on how to build the software, including required libraries, frameworks, SDKs, and dependencies. [OSPS-DO-07.01]
    It is recommended to publish this information alongside the project's contributor documentation, such as in CONTRIBUTING.md or other developer task documentation. This may also be documented using Makefile targets or other automation scripts.

    Build instructions, including the Rust toolchain version, the libpcap dependency, feature flags and platform packages, are in CONTRIBUTING.md (Prerequisites, Build from Source: https://github.com/NormB/sipnab/blob/main/CONTRIBUTING.md) and the install guide (https://sipnab.com/docs/install/, Build it from source). The full CI/release build is documented at https://sipnab.com/docs/internals/build-ci-release/


    Enough for a badge!

    The project documentation MUST include a list of project members with access to sensitive resources. [OSPS-GV-01.01]
    Document project participants and their roles through such artifacts as members.md, governance.md, maintainers.md, or similar file within the source code repository of the project. This may be as simple as including names or account handles in a list of maintainers, or more complex depending on the project's governance.

    MAINTAINERS.md (https://github.com/NormB/sipnab/blob/main/MAINTAINERS.md) lists the project's only member with access to sensitive resources: Norm Brandinger (@NormB), who owns the repository, its settings and secrets, the release pipeline, crates.io publishing, and the CLA Assistant configuration. .github/CODEOWNERS (* @NormB) records the same.


    Enough for a badge!

    The project documentation MUST include descriptions of the roles and responsibilities for members of the project [OSPS-GV-01.02]
    Document project participants and their roles through such artifacts as members.md, governance.md, maintainers.md, or similar file within the source code repository of the project.

    MAINTAINERS.md (https://github.com/NormB/sipnab/blob/main/MAINTAINERS.md) describes the maintainer's role and responsibilities: reviewing and merging pull requests, owning the CLA flow, cutting releases, and supporting only the latest release. It also states the project has no other roles and no succession plan. CONTRIBUTING.md covers the contributor role.


    Enough for a badge!

    The project documentation MUST include a guide for code contributors that includes requirements for acceptable contributions. [OSPS-GV-03.02]
    Extend the CONTRIBUTING.md or CONTRIBUTING/ contents in the project documentation to outline the requirements for acceptable contributions, including coding standards, testing requirements, and submission guidelines for code contributors. It is recommended that this guide is the source of truth for both contributors and approvers.

    https://github.com/NormB/sipnab/blob/main/CONTRIBUTING.md#code-style

    CONTRIBUTING.md states the requirements for acceptable contributions: a Code Style section (Rust standard style enforced by cargo fmt, and Clippy on a deny-on-warning basis), a Running Tests section requiring the suite to pass and new functionality to ship with tests, a Git Hooks section describing the pre-commit/pre-push gates every contribution must clear, a Documentation section, a Commit Messages convention, and a Pull Request Process section. Contributions that don't meet these (formatting, lint, tests, docs) are blocked by CI. [contribution_requirements]


    Enough for a badge!

    The version control system MUST require all code contributors to assert that they are legally authorized to make the associated contributions on every commit. [OSPS-LE-01.01]
    Include a DCO in the project's repository, requiring code contributors to assert that they are legally authorized to commit the associated contributions on every commit. Use a status check to ensure the assertion is made. A CLA also satisfies this requirement. Some version control systems, such as GitHub, may include this in the platform terms of service.

    Every contribution requires a signed Contributor License Agreement through CLA Assistant; license/cla is a required status check on main, so no pull request merges without the author's legal assertion. Only bot accounts are allowlisted: https://github.com/NormB/sipnab/blob/main/CLA.md


    Enough for a badge!

    When a commit is made to the primary branch, any automated status checks for commits MUST pass or be manually bypassed. [OSPS-QA-03.01]
    Configure the project's version control system to require that all automated status checks pass or require manual acknowledgement before a commit can be merged into the primary branch. It is recommended that any optional status checks are NOT configured as a pass or fail requirement that approvers may be tempted to bypass.

    GitHub Actions runs the suite on every push and pull request. [test_continuous_integration]


    Enough for a badge!

    Prior to a commit being accepted, the project's CI/CD pipelines MUST run at least one automated test suite to ensure the changes meet expectations. [OSPS-QA-06.01]
    Automated tests should be run prior to every merge into the primary branch. The test suite should be run in a CI/CD pipeline and the results should be visible to all contributors. The test suite should be run in a consistent environment and should be run in a way that allows contributors to run the tests locally. Examples of test suites include unit tests, integration tests, and end-to-end tests.

    GitHub Actions runs the suite on every push and pull request. [test_continuous_integration]


    Enough for a badge!

    When the project has made a release, the project documentation MUST include design documentation demonstrating all actions and actors within the system. [OSPS-SA-01.01]
    Include designs in the project documentation that explains the actions and actors. Actors include any subsystem or entity that can influence another segment in the system. Ensure this is updated for new features or breaking changes.

    Design documentation covers the system's actions and actors: docs/architecture.md (https://github.com/NormB/sipnab/blob/main/docs/architecture.md) describes the run modes, the four answer surfaces (TUI, CLI, REST API, MCP), data flow from capture sources through parsing to outputs, the module map, threading and privilege model. Internals docs (https://sipnab.com/docs/internals/) and docs/design/ cover each subsystem.


    Enough for a badge!

    When the project has made a release, the project documentation MUST include descriptions of all external software interfaces of the released software assets. [OSPS-SA-02.01]
    Document all software interfaces (APIs) of the released software assets, explaining how users can interact with the software and what data is expected or produced. Ensure this is updated for new features or breaking changes.

    sipnab exposes several external interfaces, each with reference documentation describing its inputs and outputs:
    • Command-line interface — every parameter and option is documented at https://sipnab.com/docs/cli/ (and via --help).
    • REST API — the URL/HTTP interface is documented at https://sipnab.com/docs/api/, with client examples at https://sipnab.com/docs/api-clients/.
    • MCP server — the tool surface (each tool's inputs and outputs) is documented at https://sipnab.com/docs/mcp/, with a step-by-step walkthrough at https://sipnab.com/docs/mcp-walkthrough/.
    These pages describe both inputs and outputs and are reachable from the documentation site's navigation, so the information is available without reading the source. A CI gate keeps the CLI reference and MCP tool docs synchronized with the code — every registered tool must have its own documented section, or the build fails. [documentation_interface]


    Enough for a badge!

    When the project has made a release, the project MUST perform a security assessment to understand the most likely and impactful potential security problems that could occur within the software. [OSPS-SA-03.01]
    Performing a security assessment informs both project members as well as downstream consumers that the project understands what problems could arise within the software. Understanding what threats could be realized helps the project manage and address risk. This information is useful to downstream consumers to demonstrate the security acumen and practices of the project. Ensure this is updated for new features or breaking changes.

    docs/threat-model.md is the project's security assessment: assets, trust boundaries, threats with the code that mitigates each, and residual risks: https://github.com/NormB/sipnab/blob/main/docs/threat-model.md


    Enough for a badge!

    The project documentation MUST include a policy for coordinated vulnerability disclosure (CVD), with a clear timeframe for response. [OSPS-VM-01.01]
    Create a SECURITY.md file at the root of the directory, outlining the project's policy for coordinated vulnerability disclosure. Include a method for reporting vulnerabilities. Set expectations for how the project will respond and address reported issues.

    SECURITY.md describes how to report vulnerabilities.

    The GitHub issue tracker is a publicly available, permanently retained archive of reports and their responses, and it is full-text searchable via GitHub's issue search (is:issue, plus label/author/state filters). Every issue and every comment has a stable, individually-addressable URL. It already holds a searchable history — e.g. issues #226–229 with their triage and resolution comments — at https://github.com/NormB/sipnab/issues?q=is%3Aissue . [vulnerability_report_process]


    Enough for a badge!

    The project documentation MUST provide a means for private vulnerability reporting directly to the security contacts within the project. [OSPS-VM-03.01]
    Provide a means for security researchers to report vulnerabilities privately to the project. This may be a dedicated email address, a web form, VCS specialized tools, email addresses for security contacts, or other methods.

    https://github.com/NormB/sipnab/blob/main/SECURITY.md [vulnerability_report_private]


    Enough for a badge!

    The project documentation MUST publicly publish data about discovered vulnerabilities. [OSPS-VM-04.01]
    Provide information about known vulnerabilities in a predictable public channel, such as a CVE entry, blog post, or other medium. To the degree possible, this information should include affected version(s), how a consumer can determine if they are vulnerable, and instructions for mitigation or remediation.

    The changelog flags security-relevant fixes in the entry that carries them. [release_notes_vulns]



You can use tools and AI systems to propose changes via a simple URL, such as https://www.bestpractices.dev/en/projects/13931/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. See our automation proposals system for how to do that. 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 Norm Brandinger and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Norm Brandinger.
Entry created on 2026-08-02 14:39:34 UTC, last updated on 2026-09-30 15:50:33 UTC. Last achieved passing badge on 2026-08-06 13:59:14 UTC.