aionetx

Projetos que seguem as melhores práticas abaixo podem se autocertificar voluntariamente e mostrar que alcançaram um selo de melhores práticas da Open Source Security Foundation (OpenSSF).

Não existe um conjunto de práticas que possa garantir que o software nunca terá defeitos ou vulnerabilidades; mesmo métodos formais podem falhar se as especificações ou suposições estiverem erradas. Nem existe qualquer conjunto de práticas que possa garantir que um projeto sustentará uma comunidade de desenvolvimento saudável e bem-funcionada. No entanto, seguir as melhores práticas pode ajudar a melhorar os resultados dos projetos. Por exemplo, algumas práticas permitem revisão multipessoal antes do lançamento, o que pode ajudar a encontrar vulnerabilidades técnicas difíceis de encontrar e ajudar a construir confiança e desejo de interação repetida entre desenvolvedores de diferentes empresas. Para ganhar um selo, todos os critérios DEVE e NÃO DEVE devem ser atendidos, todos os critérios DEVERIA devem ser atendidos OU não atendidos com justificativa, e todos os critérios SUGERIDO devem ser atendidos OU não atendidos (queremos que sejam considerados pelo menos). Se você quiser inserir texto de justificativa como um comentário genérico, em vez de ser uma justificativa de que a situação é aceitável, inicie o bloco de texto com '//' seguido de um espaço. Feedback é bem-vindo via site do GitHub como questões ou pull requests Há também uma lista de discussão para discussão geral.

Fornecemos com prazer as informações em vários idiomas, no entanto, se houver qualquer conflito ou inconsistência entre as traduções, a versão em inglês é a versão autoritativa.
Se este é o seu projeto, por favor mostre o status do seu selo básico na página do seu projeto! O status do selo básico se parece com isto: O nível do selo básico para o projeto 12644 é baseline-2 Aqui está como incorporar o selo básico:
Você pode mostrar o status do seu selo básico incorporando isto no seu arquivo markdown:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/12644/baseline)](https://www.bestpractices.dev/projects/12644)
ou incorporando isto no seu HTML:
<a href="https://www.bestpractices.dev/projects/12644"><img src="https://www.bestpractices.dev/projects/12644/baseline"></a>


Estes são os critérios de Nível Básico 2. Estes são critérios da versão v2026.02.19.

Baseline Series: Nível Básico 1 Nível Básico 2 Nível Básico 3

        

 Fundamentos

  • Geral

    Observe que outros projetos podem usar o mesmo nome.

    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.

    Use o formato de expressão de licença SPDX; exemplos incluem "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT" e "(BSD-2-Clause OR Ruby)". Não inclua aspas simples ou aspas duplas.
    Se houver mais de uma linguagem, liste-as como valores separados por vírgula (espaços opcionais) e ordene-as da mais usada para a menos usada. Se houver uma longa lista, liste pelo menos as três primeiras mais comuns. Se não houver linguagem (por exemplo, este é um projeto apenas de documentação ou apenas de teste), use o caractere único "-". Use uma capitalização convencional para cada linguagem, por exemplo, "JavaScript".
    O Common Platform Enumeration (CPE) é um esquema de nomenclatura estruturado para sistemas de tecnologia da informação, software e pacotes. Ele é usado em vários sistemas e bancos de dados ao relatar vulnerabilidades.

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

 Controles 19/19 ●

  • Controles


    Suficiente para um badge!

    Quando uma tarefa de CI/CD é executada sem permissões especificadas, o sistema de CI/CD DEVE definir como padrão as permissões da tarefa para as menores permissões concedidas no pipeline. [OSPS-AC-04.01]
    Configure as definições do projeto para atribuir as menores permissões disponíveis a novos pipelines por padrão, concedendo permissões adicionais somente quando necessário para tarefas específicas.

    GitHub Actions is configured with read-only default workflow permissions for this repository, and release workflows declare read-only top-level permissions with job-specific elevated permissions only where required for OIDC publishing, attestations, or release creation.


    Suficiente para um badge!

    Quando um lançamento oficial é criado, esse lançamento DEVE receber um identificador de versão único. [OSPS-BR-02.01]
    Atribua um identificador de versão único a cada versão de lançamento produzida pelo projeto, seguindo uma convenção de nomenclatura ou esquema de numeração consistente. Exemplos incluem SemVer, CalVer ou id de commit git.

    Official releases use unique SemVer-style version identifiers. pyproject.toml declares the package version, CHANGELOG.md records release entries, and the release workflow verifies that release tags match the declared project version before publishing: https://github.com/MarcusKorinth/aionetx/blob/main/pyproject.toml, https://github.com/MarcusKorinth/aionetx/blob/main/CHANGELOG.md, https://github.com/MarcusKorinth/aionetx/blob/main/.github/workflows/release.yml.


    Suficiente para um badge!

    Quando um lançamento oficial é criado, esse lançamento DEVE conter um registro descritivo de modificações funcionais e de segurança. [OSPS-BR-04.01]
    Certifique-se de que todos os lançamentos incluam um registro de alterações descritivo. É recomendado garantir que o registro de alterações seja legível por humanos e inclua detalhes além das mensagens de commit, como descrições do impacto de segurança ou relevância para diferentes casos de uso. Para garantir a legibilidade por máquina, coloque o conteúdo sob um cabeçalho markdown como \"## Changelog\"."

    CHANGELOG.md documents human-readable release notes for user-visible changes, including functional changes and security-relevant release information when applicable: https://github.com/MarcusKorinth/aionetx/blob/main/CHANGELOG.md.


    Suficiente para um badge!

    Quando um pipeline de compilação e lançamento ingere dependências, ele DEVE usar ferramentas padronizadas quando disponíveis. [OSPS-BR-05.01]
    Use ferramentas comuns para o seu ecossistema, como gerenciadores de pacotes ou ferramentas de gerenciamento de dependências para ingerir dependências no momento da compilação. Isso pode incluir o uso de um arquivo de dependências, arquivo de bloqueio ou manifesto para especificar as dependências necessárias, que são então incorporadas pelo sistema de compilação.

    The build and release workflows use standardized Python packaging tooling, including pyproject.toml, pip, python -m build, wheel, setuptools, and twine. Dependency metadata is declared in pyproject.toml: https://github.com/MarcusKorinth/aionetx/blob/main/pyproject.toml, https://github.com/MarcusKorinth/aionetx/blob/main/.github/workflows/release.yml.


    Suficiente para um badge!

    Quando um lançamento oficial é criado, esse lançamento DEVE ser assinado ou contabilizado em um manifesto assinado incluindo os hashes criptográficos de cada ativo. [OSPS-BR-06.01]
    Assine todos os ativos de software lançados no momento da construção com uma assinatura criptográfica ou atestados, como assinatura GPG ou PGP, assinaturas Sigstore, proveniência SLSA ou VSAs SLSA. Inclua os hashes criptográficos de cada ativo em um manifesto assinado ou arquivo de metadados.

    The release workflow creates GitHub artifact attestations / SLSA provenance for the wheel and source distribution and generates an SPDX SBOM for release assets. Release artifacts are built from the verified tag and accounted for through the release workflow: https://github.com/MarcusKorinth/aionetx/blob/main/.github/workflows/release.yml.


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, a documentação do projeto DEVE incluir uma descrição de como o projeto seleciona, obtém e rastreia suas dependências. [OSPS-DO-06.01]
    É recomendado publicar essas informações juntamente com a documentação técnica e de design do projeto em um recurso publicamente visível, como o repositório de código-fonte, site do projeto ou outro canal.

    Runtime and development dependencies are declared in pyproject.toml. The project currently has zero runtime dependencies outside the Python standard library, and Dependabot tracks development and GitHub Actions dependency updates: https://github.com/MarcusKorinth/aionetx/blob/main/pyproject.toml, https://github.com/MarcusKorinth/aionetx/blob/main/.github/dependabot.yml, https://github.com/MarcusKorinth/aionetx/blob/main/SECURITY.md.


    Suficiente para um badge!

    A documentação do projeto DEVE incluir instruções sobre como compilar o software, incluindo bibliotecas, frameworks, SDKs e dependências necessários. [OSPS-DO-07.01]
    Recomenda-se publicar essas informações junto com a documentação de colaboradores do projeto, como em CONTRIBUTING.md ou outra documentação de tarefas de desenvolvimento. Isso também pode ser documentado usando alvos de Makefile ou outros scripts de automação.

    README.md documents local installation and development setup, while docs/reproducible_build.md documents how to rebuild release artifacts from source using standard Python build tooling: https://github.com/MarcusKorinth/aionetx/blob/main/README.md#installation-and-local-development, https://github.com/MarcusKorinth/aionetx/blob/main/docs/reproducible_build.md.


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir uma lista de membros do projeto com acesso a recursos sensíveis. [OSPS-GV-01.01]
    Documente os participantes do projeto e seus papéis através de artefatos como members.md, governance.md, maintainers.md ou arquivo similar dentro do repositório de código-fonte do projeto. Isso pode ser tão simples quanto incluir nomes ou identificadores de conta em uma lista de mantenedores, ou mais complexo dependendo da governança do projeto.

    aionetx is currently maintained by a single developer. SECURITY.md documents the single-maintainer model and response expectations for sensitive vulnerability handling: https://github.com/MarcusKorinth/aionetx/blob/main/SECURITY.md.


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir descrições dos papéis e responsabilidades dos membros do projeto. [OSPS-GV-01.02]
    Documente os participantes do projeto e seus papéis através de artefatos como members.md, governance.md, maintainers.md ou arquivo similar dentro do repositório de código-fonte do projeto.

    SECURITY.md documents maintainer responsibilities for vulnerability acknowledgement, triage, fix prioritization, and coordinated disclosure. CONTRIBUTING.md documents contributor responsibilities for pull requests, tests, linting, typing, documentation updates, and focused changes: https://github.com/MarcusKorinth/aionetx/blob/main/SECURITY.md, https://github.com/MarcusKorinth/aionetx/blob/main/CONTRIBUTING.md.


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir um guia para contribuidores de código que inclui requisitos para contribuições aceitáveis. [OSPS-GV-03.02]
    Estenda o conteúdo de CONTRIBUTING.md ou CONTRIBUTING/ na documentação do projeto para delinear os requisitos para contribuições aceitáveis, incluindo padrões de codificação, requisitos de testes e diretrizes de submissão para contribuidores de código. É recomendado que este guia seja a fonte da verdade tanto para contribuidores quanto para aprovadores.

    CONTRIBUTING.md documents acceptable contribution requirements, including focused pull requests, Conventional Commits, tests for behavior changes, regression tests for fixes, ruff, mypy, and documentation updates for user-visible behavior: https://github.com/MarcusKorinth/aionetx/blob/main/CONTRIBUTING.md.


    Suficiente para um badge!

    Enquanto ativo, o sistema de controle de versão DEVE exigir que todos os contribuidores de código afirmem que estão legalmente autorizados a fazer as contribuições associadas em cada commit. [OSPS-LE-01.01]
    Inclua um DCO no repositório do projeto, exigindo que os contribuidores de código afirmem que estão legalmente autorizados a confirmar as contribuições associadas em cada commit. Use uma verificação de status para garantir que a afirmação seja feita. Um CLA também satisfaz este requisito. Alguns sistemas de controle de versão, como o GitHub, podem incluir isso nos termos de serviço da plataforma.

    The repository requires DCO sign-off for code contributions. The DCO GitHub App runs on pull requests, and the active main branch ruleset requires the DCO status check before changes can be merged.


    Suficiente para um badge!

    Quando um commit é feito na branch primária, quaisquer verificações de status automatizadas para commits DEVEM passar ou ser manualmente ignoradas. [OSPS-QA-03.01]
    Configure o sistema de controle de versão do projeto para exigir que todas as verificações de status automatizadas passem ou exijam reconhecimento manual antes que um commit possa ser mesclado na branch primária. É recomendado que quaisquer verificações de status opcionais NÃO sejam configuradas como um requisito de aprovação ou reprovação que os aprovadores possam ser tentados a ignorar.

    The main branch is protected by an active GitHub branch ruleset requiring pull requests, up-to-date branches, and required status checks before changes can be merged to the primary branch.


    Suficiente para um badge!

    Antes de um commit ser aceito, os pipelines de CI/CD do projeto DEVEM executar pelo menos um conjunto de testes automatizados para garantir que as alterações atendam às expectativas. [OSPS-QA-06.01]
    Testes automatizados devem ser executados antes de cada mesclagem na branch primária. O conjunto de testes deve ser executado em um pipeline de CI/CD e os resultados devem ser visíveis a todos os contribuidores. O conjunto de testes deve ser executado em um ambiente consistente e deve ser executado de uma maneira que permita aos contribuidores executar os testes localmente. Exemplos de conjuntos de testes incluem testes unitários, testes de integração e testes de ponta a ponta.

    The main branch ruleset requires CI status checks before merge. The required CI profile runs pytest-based behavior, integration, reliability, coverage, packaging, static correctness, CodeQL, and Scorecard checks before changes are accepted: https://github.com/MarcusKorinth/aionetx/blob/main/.github/workflows/ci.yml.


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, a documentação do projeto DEVE incluir documentação de design demonstrando todas as ações e atores dentro do sistema. [OSPS-SA-01.01]
    Inclua designs na documentação do projeto que expliquem as ações e atores. Atores incluem qualquer subsistema ou entidade que possa influenciar outro segmento no sistema. Certifique-se de que isso seja atualizado para novos recursos ou mudanças que quebrem compatibilidade.

    docs/architecture.md and README.md document the project architecture, transport roles, lifecycle model, event dispatch model, factory responsibilities, TCP/UDP/multicast boundaries, reconnect behavior, heartbeat behavior, and public/internal API boundaries: https://github.com/MarcusKorinth/aionetx/blob/main/docs/architecture.md, https://github.com/MarcusKorinth/aionetx/blob/main/README.md.


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, a documentação do projeto DEVE incluir descrições de todas as interfaces de software externas dos ativos de software lançados. [OSPS-SA-02.01]
    Documente todas as interfaces de software (APIs) dos ativos de software lançados, explicando como os usuários podem interagir com o software e quais dados são esperados ou produzidos. Certifique-se de que isso seja atualizado para novos recursos ou mudanças que quebrem compatibilidade.

    README.md documents the public API overview, transport roles, settings objects, lifecycle states, event types, event handler contract, and usage examples. The typed public API is exposed under aionetx and aionetx.api with py.typed metadata: https://github.com/MarcusKorinth/aionetx/blob/main/README.md#public-api-overview, https://github.com/MarcusKorinth/aionetx/tree/main/src/aionetx/api.


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, o projeto DEVE realizar uma avaliação de segurança para compreender os problemas de segurança potenciais mais prováveis e impactantes que poderiam ocorrer dentro do software. [OSPS-SA-03.01]
    Realizar uma avaliação de segurança informa tanto os membros do projeto quanto os consumidores a jusante que o projeto compreende quais problemas poderiam surgir dentro do software. Compreender quais ameaças poderiam se concretizar ajuda o projeto a gerenciar e tratar riscos. Essa informação é útil para os consumidores a jusante demonstrarem a perspicácia e as práticas de segurança do projeto. Certifique-se de que isso seja atualizado para novos recursos ou mudanças disruptivas.

    SECURITY.md documents the security assessment scope for this raw-byte transport library, including no built-in authentication, authorization, or encryption, denial-of-service boundaries, dependency scope, lifecycle/resource-leak security concerns, and private reporting expectations: https://github.com/MarcusKorinth/aionetx/blob/main/SECURITY.md.


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir uma política para divulgação coordenada de vulnerabilidades (CVD), com um prazo claro para resposta. [OSPS-VM-01.01]
    Crie um arquivo SECURITY.md na raiz do diretório, descrevendo a política do projeto para divulgação coordenada de vulnerabilidades. Inclua um método para relatar vulnerabilidades. Estabeleça expectativas sobre como o projeto responderá e tratará problemas relatados.

    SECURITY.md documents coordinated vulnerability disclosure, acknowledgement within 7 calendar days, triage and initial assessment within 14 calendar days, severity-based fix prioritization, and a typical disclosure window of up to 90 days: https://github.com/MarcusKorinth/aionetx/blob/main/SECURITY.md.


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE fornecer um meio para relato privado de vulnerabilidades diretamente aos contatos de segurança dentro do projeto. [OSPS-VM-03.01]
    Forneça um meio para que pesquisadores de segurança relatem vulnerabilidades privadamente ao projeto. Isso pode ser um endereço de e-mail dedicado, um formulário web, ferramentas especializadas do VCS, endereços de e-mail para contatos de segurança ou outros métodos.

    SECURITY.md directs reporters to GitHub private vulnerability reporting through the repository Security tab so reports are visible only to maintainers and the reporter until disclosure: https://github.com/MarcusKorinth/aionetx/blob/main/SECURITY.md, https://github.com/MarcusKorinth/aionetx/security.


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE publicar publicamente dados sobre vulnerabilidades descobertas. [OSPS-VM-04.01]
    Forneça informações sobre vulnerabilidades conhecidas em um canal público previsível, como uma entrada CVE, postagem em blog ou outro meio. Na medida do possível, essa informação deve incluir versão(ões) afetada(s), como um consumidor pode determinar se está vulnerável e instruções para mitigação ou remediação.

    SECURITY.md states that once a fix is available and released, the maintainers publish a GitHub Security Advisory referencing affected versions, CVE if assigned, fixed version, and credits. There are currently no publicly known vulnerabilities for this project: https://github.com/MarcusKorinth/aionetx/blob/main/SECURITY.md.



Estes dados estão disponíveis sob o Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). Isso significa que um Destinatário de Dados pode compartilhar os Dados, com ou sem modificações, desde que o Destinatário de Dados disponibilize o texto deste acordo com os Dados compartilhados. Por favor, dê crédito a Marcus Korinth e aos contribuidores do selo de melhores práticas OpenSSF.

Entrada de selo do projeto de propriedade de: Marcus Korinth.
Entrada criada em 2026-04-25 10:05:38 UTC, última atualização em 2026-04-25 15:56:04 UTC.