aionetx

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 12644 is baseline-2 Here is how to embed the baseline badge:
You can show your baseline badge status by embedding this in your markdown file:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/12644/baseline)](https://www.bestpractices.dev/projects/12644)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/12644"><img src="https://www.bestpractices.dev/projects/12644/baseline"></a>


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

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

        

 Basics

  • General

    Note that other projects may use the same name.

    aionetx is an asyncio-first Python transport library for reusable TCP, UDP, and multicast communication primitives with explicit lifecycle management, structured event delivery, configurable backpressure, and typed public APIs.

    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.

    aionetx is currently a pre-1.0 / alpha transport library and is not advertised as production-ready.

 Controls 25/25 ●

  • Controls


    Enough for a badge!

    When a user attempts to read or modify a sensitive resource in the project's authoritative repository, the system MUST require the user to complete a multi-factor authentication process. [OSPS-AC-01.01]
    Enforce multi-factor authentication for the project's version control system, requiring collaborators to provide a second form of authentication when accessing sensitive data or modifying repository settings. Passkeys are acceptable for this control.

    GitHub requires multi-factor authentication for accounts contributing code, and the authoritative repository is hosted on GitHub: https://github.com/MarcusKorinth/aionetx.


    Enough for a badge!

    When a new collaborator is added, the version control system MUST require manual permission assignment, or restrict the collaborator permissions to the lowest available privileges by default. [OSPS-AC-02.01]
    Most public version control systems are configured in this manner. Ensure the project's version control system always assigns the lowest available permissions to collaborators by default when added, granting additional permissions only when necessary.

    GitHub requires explicit collaborator or role assignment before a user receives elevated repository permissions. The repository is hosted on GitHub: https://github.com/MarcusKorinth/aionetx.


    Enough for a badge!

    When a direct commit is attempted on the project's primary branch, an enforcement mechanism MUST prevent the change from being applied. [OSPS-AC-03.01]
    If the VCS is centralized, set branch protection on the primary branch in the project's VCS. Alternatively, use a decentralized approach, like the Linux kernel's, where changes are first proposed in another repository, and merging changes into the primary repository requires a specific separate act.

    The main branch is protected by an active GitHub branch ruleset requiring pull requests before updates and required status checks before merging.


    Enough for a badge!

    When an attempt is made to delete the project's primary branch, the version control system MUST treat this as a sensitive activity and require explicit confirmation of intent. [OSPS-AC-03.02]
    Set branch protection on the primary branch in the project's version control system to prevent deletion.

    The main branch is protected by an active GitHub branch ruleset that restricts deletion and blocks non-fast-forward updates / force pushes.


    Enough for a badge!

    When a CI/CD pipeline operates on untrusted metadata, those parameters MUST be sanitized and validated prior to use in the pipeline. [OSPS-BR-01.01]
    CI/CD pipelines should sanitize (quote, escape or exit on expected values) all metadata inputs which correspond to untrusted sources. This includes data such as branch names, commit messages, tags, pull request titles, and author information.

    CI workflows avoid executing untrusted pull request metadata as shell commands, and release inputs are constrained or validated by the release workflow and validate_release_provenance.py: https://github.com/MarcusKorinth/aionetx/blob/main/.github/workflows/release.yml, https://github.com/MarcusKorinth/aionetx/blob/main/scripts/ci/validate_release_provenance.py.


    Enough for a badge!

    (Future criterion) When a CI/CD pipeline operates on untrusted code snapshots, it MUST prevent access to privileged CI/CD credentials and assets. [OSPS-BR-01.03]
    CI/CD pipelines should isolate untrusted code snapshots from privileged credentials and assets. In particular, projects should be careful to ensure that workflows which build or execute code prior to review by a collaborator do not have access to CI/CD credentials.

    Pull request CI runs with read-only default workflow permissions and does not publish packages or use release credentials. Package publishing is isolated in the release workflow and uses OIDC Trusted Publishing after release gates: https://github.com/MarcusKorinth/aionetx/blob/main/.github/workflows/ci.yml, https://github.com/MarcusKorinth/aionetx/blob/main/.github/workflows/release.yml.


    Enough for a badge!

    When the project lists a URI as an official project channel, that URI MUST be exclusively delivered using encrypted channels. [OSPS-BR-03.01]
    Configure the project's websites and version control systems to use encrypted channels such as SSH or HTTPS for data transmission. Ensure all tools and domains referenced in project documentation can only be accessed via encrypted channels.

    All official project channels listed for this project use HTTPS URLs, including the repository, documentation, issues, pull requests, discussions, and security reporting channel.


    Enough for a badge!

    When the project lists a URI as an official distribution channel, that channel MUST be protected from adversary-in-the-middle attacks using cryptographically authenticated channels. [OSPS-BR-03.02]
    Artifacts distributed by the project should be distributed through channels which ensure integrity and authenticity. Use of HTTPS for downloads, signed releases, or distribution through trusted package managers are all acceptable methods to protect against adversary-in-the-middle attacks.

    Distribution channels use HTTPS and trusted package/release infrastructure. The release workflow publishes through PyPI/TestPyPI OIDC Trusted Publishing: https://github.com/MarcusKorinth/aionetx/blob/main/.github/workflows/release.yml.


    Enough for a badge!

    The project MUST prevent the unintentional storage of unencrypted sensitive data, such as secrets and credentials, in the version control system. [OSPS-BR-07.01]
    Configure .gitignore or equivalent to exclude files that may contain sensitive information. Use pre-commit hooks and automated scanning tools to detect and prevent the inclusion of sensitive data in commits.

    Distribution channels use HTTPS and trusted package/release infrastructure. The release workflow publishes through PyPI/TestPyPI OIDC Trusted Publishing: https://github.com/MarcusKorinth/aionetx/blob/main/.github/workflows/release.yml.


    Enough for a badge!

    When the project has made a release, the project documentation MUST include user guides for all basic functionality. [OSPS-DO-01.01]
    Create user guides or documentation for all basic functionality of the project, explaining how to install, configure, and use the project's features. If there are any known dangerous or destructive actions available, include highly-visible warnings.

    README.md documents installation, quickstart usage, project scope, lifecycle/event concepts, examples, and links to additional documentation: https://github.com/MarcusKorinth/aionetx/blob/main/README.md.


    Enough for a badge!

    When the project has made a release, the project documentation MUST include a guide for reporting defects. [OSPS-DO-02.01]
    It is recommended that projects use their VCS default issue tracker. If an external source is used, ensure that the project documentation and contributing guide clearly and visibly explain how to use the reporting system. It is recommended that project documentation also sets expectations for how defects will be triaged and resolved.

    SUPPORT.md and the GitHub issue templates document how to report defects and what information to include: https://github.com/MarcusKorinth/aionetx/blob/main/SUPPORT.md, https://github.com/MarcusKorinth/aionetx/issues/new/choose.


    Enough for a badge!

    While active, the project MUST have one or more mechanisms for public discussions about proposed changes and usage obstacles. [OSPS-GV-02.01]
    Establish one or more mechanisms for public discussions within the project, such as mailing lists, instant messaging, or issue trackers, to facilitate open communication and feedback.

    GitHub Issues, Pull Requests, and Discussions provide public mechanisms for proposed changes, usage questions, and obstacles: https://github.com/MarcusKorinth/aionetx/issues, https://github.com/MarcusKorinth/aionetx/pulls, https://github.com/MarcusKorinth/aionetx/discussions.


    Enough for a badge!

    While active, the project documentation MUST include an explanation of the contribution process. [OSPS-GV-03.01]
    Create a CONTRIBUTING.md or CONTRIBUTING/ directory to outline the contribution process including the steps for submitting changes, and engaging with the project maintainers.

    CONTRIBUTING.md explains the contribution workflow, pull requests, branch naming, tests, linting, type checking, and documentation expectations: https://github.com/MarcusKorinth/aionetx/blob/main/CONTRIBUTING.md.


    Enough for a badge!

    While active, the license for the source code MUST meet the OSI Open Source Definition or the FSF Free Software Definition. [OSPS-LE-02.01]
    Add a LICENSE file to the project's repo with a license that is an approved license by the Open Source Initiative (OSI), or a free license as approved by the Free Software Foundation (FSF). Examples of such licenses include the MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). Releasing to the public domain meets this control if there are no other encumbrances such as patents.

    The source code is released under the MIT license, which is approved by the Open Source Initiative: https://github.com/MarcusKorinth/aionetx/blob/main/LICENSE.


    Enough for a badge!

    While active, the license for the released software assets MUST meet the OSI Open Source Definition or the FSF Free Software Definition. [OSPS-LE-02.02]
    If a different license is included with released software assets, ensure it is an approved license by the Open Source Initiative (OSI), or a free license as approved by the Free Software Foundation (FSF). Examples of such licenses include the MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). Note that the license for the released software assets may be different than the source code.

    Released package assets use the same MIT license, declared in pyproject.toml and included through license-files: https://github.com/MarcusKorinth/aionetx/blob/main/pyproject.toml.


    Enough for a badge!

    While active, the license for the source code MUST be maintained in the corresponding repository's LICENSE file, COPYING file, or LICENSE/ directory. [OSPS-LE-03.01]
    Include the project's source code license in the project's LICENSE file, COPYING file, or LICENSE/ directory to provide visibility and clarity on the licensing terms. The filename MAY have an extension. If the project has multiple repositories, ensure that each repository includes the license file.

    The repository contains the MIT license text in the root LICENSE file: https://github.com/MarcusKorinth/aionetx/blob/main/LICENSE.


    Enough for a badge!

    While active, the license for the released software assets MUST be included in the released source code, or in a LICENSE file, COPYING file, or LICENSE/ directory alongside the corresponding release assets. [OSPS-LE-03.02]
    Include the project's released software assets license in the released source code, or in a LICENSE file, COPYING file, or LICENSE/ directory alongside the corresponding release assets to provide visibility and clarity on the licensing terms. The filename MAY have an extension. If the project has multiple repositories, ensure that each repository includes the license file.

    pyproject.toml declares license-files = ["LICENSE"], so source distributions and wheels include the repository LICENSE file: https://github.com/MarcusKorinth/aionetx/blob/main/pyproject.toml.


    Enough for a badge!

    While active, the project's source code repository MUST be publicly readable at a static URL. [OSPS-QA-01.01]
    Use a common VCS such as GitHub, GitLab, or Bitbucket. Ensure the repository is publicly readable. Avoid duplication or mirroring of repositories unless highly visible documentation clarifies the primary source. Avoid frequent changes to the repository that would impact the repository URL. Ensure the repository is public.

    The public source repository is available at a stable GitHub URL: https://github.com/MarcusKorinth/aionetx.


    Enough for a badge!

    The version control system MUST contain a publicly readable record of all changes made, who made the changes, and when the changes were made. [OSPS-QA-01.02]
    Use a common VCS such as GitHub, GitLab, or Bitbucket to maintain a publicly readable commit history. Avoid squashing or rewriting commits in a way that would obscure the author of any commits.

    GitHub/git provides a publicly readable commit history with commits, authors, timestamps, branches, and pull requests: https://github.com/MarcusKorinth/aionetx/commits/main.


    Enough for a badge!

    When the package management system supports it, the source code repository MUST contain a dependency list that accounts for the direct language dependencies. [OSPS-QA-02.01]
    This may take the form of a package manager or language dependency file that enumerates all direct dependencies such as package.json, Gemfile, or go.mod.

    pyproject.toml declares the package metadata, runtime dependencies, and development extras. Runtime dependencies are intentionally empty for this release: https://github.com/MarcusKorinth/aionetx/blob/main/pyproject.toml.


    Enough for a badge!

    Projects with multiple repositories MUST document a list of codebases that are part of the project. [OSPS-QA-04.01]
    Document any additional subproject code repositories produced by the project and compiled into a release. This documentation should include the status and intent of the respective codebase.

    aionetx is currently maintained as a single source repository; there are no additional project code repositories to list.


    Enough for a badge!

    While active, the version control system MUST NOT contain generated executable artifacts. [OSPS-QA-05.01]
    Remove generated executable artifacts in the project's version control system. It is recommended that any scenario where a generated executable artifact appears critical to a process such as testing, it should be instead be generated at build time or stored separately and fetched during a specific well-documented pipeline step.

    The repository does not track generated executable artifacts such as wheels, sdists, shared libraries, executables, or bytecode files. Build outputs are excluded by .gitignore.


    Enough for a badge!

    While active, the version control system MUST NOT contain unreviewable binary artifacts. [OSPS-QA-05.02]
    Do not add any unreviewable binary artifacts to the project's version control system. This includes executable application binaries, library files, and similar artifacts. It does not include assets such as graphical images, sound or music files, and similar content typically stored in a binary format.

    The tracked repository contents are source code, tests, scripts, workflow files, and documentation. No unreviewable binary artifacts are tracked in version control.


    Enough for a badge!

    While active, the project documentation MUST contain security contacts. [OSPS-VM-02.01]
    Create a security.md (or similarly-named) file that contains security contacts for the project.

    SECURITY.md designates GitHub private vulnerability reporting through the repository Security tab as the security contact channel for maintainers: https://github.com/MarcusKorinth/aionetx/blob/main/SECURITY.md, https://github.com/MarcusKorinth/aionetx/security.


    Enough for a badge!

    (Obsolete criterion) When a CI/CD pipeline uses a branch name in its functionality, that name value MUST be sanitized and validated prior to use in the pipeline. [OSPS-BR-01.02]

    The workflows do not use untrusted branch names as executable shell input. Release-sensitive ref and version values are validated through the release provenance script before publishing: https://github.com/MarcusKorinth/aionetx/blob/main/scripts/ci/validate_release_provenance.py.



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

Project badge entry owned by: Marcus Korinth.
Entry created on 2026-04-25 10:05:38 UTC, last updated on 2026-04-25 15:56:04 UTC.