portanode

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

    Portable (external disk) cross-platform Bitcoin full node.

    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 18/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.

    The default GITHUB_TOKEN is read-only and cannot approve pull requests (gh api repos/btclib-org/portanode/actions/permissions/workflow). Every workflow also sets permissions: contents: read at the top. https://github.com/btclib-org/portanode/blob/main/REPOSITORY.md#token-permissions


    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.

    Each release has a unique calendar version, YYYY.M.D, set by a signed v* tag. A fix to a shipped release is another day's release. https://github.com/btclib-org/portanode/blob/main/RELEASING.md#the-version-string


    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".

    The GitHub release body is RELEASE_NOTES.md's section for that release: what a user must act on. CHANGELOG.md lists what changed. https://github.com/btclib-org/portanode/blob/main/RELEASE_NOTES.md


    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.

    No build ingests a dependency, and a release is a tag. CI installs its tools with pre-commit at the revisions .pre-commit-config.yaml pins, and every third-party action is pinned by commit SHA. https://github.com/btclib-org/portanode/blob/main/.pre-commit-config.yaml


    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.

    Each release is a signed annotated tag, and GitHub verifies its signature. The tag covers the commit and every file in it. The source archive GitHub generates carries no signature of its own. https://github.com/btclib-org/portanode/tags


    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.

    README.md's Updating Binaries says how Bitcoin Core and Electrum are obtained and verified: from their publishers, with PGP signatures from pinned keys. .github/dependabot.yml says how the actions are tracked, and .pre-commit-config.yaml's ci: block how the hook revisions are. https://github.com/btclib-org/portanode/blob/main/README.md#updating-binaries


    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.

    Nothing is built: README.md's Getting the folder and Updating Binaries say how to assemble a working folder, and Prerequisites names gpg. CONTRIBUTING.md gives the development environment: uv, then uvx pre-commit. https://github.com/btclib-org/portanode/blob/main/README.md#getting-the-folder


    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.

    GOVERNANCE.md's Roles names who holds access to sensitive resources: fametrano is the maintainer, and the three owners, named by login, administer every repository. This repository has no direct collaborator. https://github.com/btclib-org/.github/blob/main/GOVERNANCE.md#roles


    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.

    GOVERNANCE.md's Roles describes the maintainer, owners, repository collaborators, contributors, reviewers, the review bot, Dependabot and pre-commit.ci, and what each owes. https://github.com/btclib-org/.github/blob/main/GOVERNANCE.md#roles


    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.

    CONTRIBUTING.md states what a contribution must meet: one subject, a Signed-off-by trailer on every commit, the gates CI runs, and a review against REVIEWING.md. https://github.com/btclib-org/portanode/blob/main/CONTRIBUTING.md


    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.

    main requires the Sign-off check, which refuses a commit that lacks its author's Signed-off-by: trailer, Dependabot's and pre-commit.ci's aside. Web commits are signed off automatically. https://github.com/btclib-org/.github/blob/main/.github/scripts/check_sign_off.py


    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.

    main requires the Lint, Dependency review and Sign-off checks. enforce_admins is off, so an admin merge without them is a manual bypass, which the control allows. https://github.com/btclib-org/portanode/blob/main/REPOSITORY.md#what-gates-a-merge


    Not 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.

    The tree has no automated test suite: lint.yml runs the pre-commit hooks and nothing runs a launcher. CONTRIBUTING.md says a launcher is tested by running it by hand on macOS, Windows and Linux. The required checks are lint, dependency review and sign-off. https://github.com/btclib-org/portanode/blob/main/CONTRIBUTING.md#the-environment-and-the-gates


    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.

    README.md names the actors and actions: the user and the launchers, the per-platform scripts they reach, Bitcoin Core and Electrum, the publishers' download sites, gpg and the user's keyring. Updating Binaries and Limitations, not vulnerabilities say what each update, verification and rollback does and whom it trusts. https://github.com/btclib-org/portanode/blob/main/README.md#folder-structure https://github.com/btclib-org/portanode/blob/main/README.md#limitations-not-vulnerabilities


    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.

    README.md and each scripts directory's README.md document the interface: every launcher and its menu, the PORTANODE_ROOT, PORTANODE_ALLOW_UNVERIFIED and PORTANODE_NO_NOTIFY variables, the pin files and the exit statuses of set-permissions. https://github.com/btclib-org/portanode/blob/main/README.md


    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.

    README.md's Limitations, not vulnerabilities assesses the known risks of running the folder: the user's keyring as the trust root, the switch that installs unverified binaries, checksums that give integrity and not authenticity, an unencrypted portable folder, Bitcoin Core's exFAT warning, and unsigned launchers. https://github.com/btclib-org/portanode/blob/main/README.md#limitations-not-vulnerabilities


    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.

    The security policy's Reporting a vulnerability gives the private channels and the timeframes: a report is acknowledged within 7 days, and a fix or a published advisory follows within 90 days. https://github.com/btclib-org/portanode/security/policy


    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.

    Private vulnerability reporting is enabled, and the security policy and the issue form's contact link point to it, with an email address as the alternative. https://github.com/btclib-org/portanode/security/advisories/new


    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.

    A vulnerability is published as a GitHub security advisory on this repository, as the security policy says. None has been published. https://github.com/btclib-org/portanode/security/advisories



You can use tools and AI systems to propose changes via a simple URL, such as https://www.bestpractices.dev/en/projects/15649/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 Ferdinando Ametrano and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Ferdinando Ametrano.
Entry created on 2026-10-18 11:16:35 UTC, last updated on 2026-10-18 14:34:30 UTC.