flowpact

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 15403 é 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/15403/baseline)](https://www.bestpractices.dev/projects/15403)
ou incorporando isto no seu HTML:
<a href="https://www.bestpractices.dev/projects/15403"><img src="https://www.bestpractices.dev/projects/15403/baseline"></a>


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

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.

    Data-flow linter for GitHub Actions: finds inputs, secrets and matrix values that arrive empty across reusable workflows, local actions and matrix combinations, and grades the release impact of changes. CLI, GitHub Action, VS Code extension.

    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.

 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.

    The GITHUB_TOKEN default is read-only, the lowest setting, for both the ciatlas organization and the repository, and workflows cannot approve pull requests, so a job that sets no permissions gets read access only. Every workflow also sets its own top-level permissions: contents: read in most, {} in pr-title.yml, read-all in scorecard.yml, and in docs.yml contents: read with pages: write and id-token: write for the Pages deployment. Other write scopes are granted only on the jobs that use them (https://github.com/ciatlas/flowpact/tree/main/.github/workflows).


    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.

    Every release gets a unique Semantic Versioning number and a vX.Y.Z tag, which release-please computes from Conventional Commit titles (https://github.com/ciatlas/flowpact/blob/main/release-please-config.json, https://github.com/ciatlas/flowpact/blob/main/CHANGELOG.md). npm never accepts a version twice, releases are immutable since 0.10.0, and a ruleset lets only the release bot and admins create, move or delete v* tags.


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

    Every release has a descriptive changelog, both on its GitHub release page (https://github.com/ciatlas/flowpact/releases) and in https://github.com/ciatlas/flowpact/blob/main/CHANGELOG.md. It groups changes into breaking changes with upgrade steps, features, bug fixes and performance, written from user-facing PR titles. Security-relevant changes are listed too, for example 0.9.0's 'harden 0.9.0 before its release: flag values, plugins, report paths and release assets' and 0.12.1's bounded walking of linked directories.


    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 pipelines take dependencies through pnpm, the project's standard package manager. The version is pinned in package.json's packageManager, and every CI and release job runs pnpm install --frozen-lockfile against the committed lockfile (https://github.com/ciatlas/flowpact/blob/main/.github/workflows/release.yml, https://github.com/ciatlas/flowpact/blob/main/.github/workflows/ci.yml). Workflow actions are pinned to commit SHAs and updated by Renovate.


    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 npm tarball, the Action archive and the .vsix each have a Sigstore-signed SLSA build provenance attestation from GitHub Actions, attached as .sigstore.json and .intoto.jsonl, and each CycloneDX SBOM is attested against its artifact. Since 0.10.0 every release is also an immutable GitHub release whose signed release attestation lists the SHA-256 of every attached file (gh release verify), and the npm package has npm provenance. See https://github.com/ciatlas/flowpact/blob/main/SECURITY.md#verifying-releases and https://ciatlas.github.io/flowpact/docs/security/#verify-a-release.


    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.

    https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#dependencies describes how dependencies are selected (reviewed in a pull request, bundled into every artifact), obtained (pnpm with a frozen lockfile, a two-day minimum release age, install scripts only for allowlisted packages, @ciatlas/core from a release tag, actions pinned to commit SHAs) and tracked (Renovate, OSV vulnerability alerts, and an SBOM and license notices in every release).


    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.

    https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#setup lists what a build needs: Node.js 22 or later, and pnpm, pinned in package.json and enabled with corepack enable. It also gives the commands. pnpm install fetches every dependency from the lockfile, including the workflow model @ciatlas/core from its GitHub release tag (explained in the next section). pnpm build bundles the CLI and the GitHub Action.


    Suficiente para um badge!

    A documentação do projeto DEVE incluir uma lista dos 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.

    https://github.com/ciatlas/flowpact/blob/main/MAINTAINERS.md#access-to-sensitive-resources lists everyone and everything with access to the project's sensitive resources: the GitHub organization and repositories, the two GitHub Apps and their permissions, the release bot's credentials, and the npm, VS Code Marketplace, Azure and Open VSX accounts that publish releases.


    Suficiente para um badge!

    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.

    https://github.com/ciatlas/flowpact/blob/main/MAINTAINERS.md#roles-and-responsibilities describes the roles (maintainer, contributors, the release bot, Renovate) and what each is responsible for, and how access is given and taken away when people join or leave.


    Suficiente para um badge!

    A documentação do projeto DEVE incluir um guia para contribuidores de código que inclua os 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.

    https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#pull-requests sets the requirements for an acceptable contribution. They are a Conventional Commits PR title and the required CI checks: Biome lint, typecheck, tests on Node 22 and 24, line coverage of at least 80% overall and 90% in packages/lint, and fallow code health. A behaviour change needs tests, and a bug fix needs a test that fails without it. Docs and the committed action bundle must be regenerated, and a code owner must approve.


    Suficiente para um badge!

    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.

    Every change reaches main through a pull request on GitHub (the main ruleset requires one and has no bypass, https://github.com/ciatlas/flowpact/blob/main/.github/rulesets/main.json). Under section D.6 of GitHub's Terms of Service, contributors to this MIT-licensed repository assert they have the right to license their contributions, as https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#pull-requests also states.


    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 live main ruleset has no bypass actors and requires the 'CI passed' and 'Conventional PR title' checks to pass on an up-to-date branch before any merge (https://github.com/ciatlas/flowpact/blob/main/.github/rulesets/main.json). 'CI passed' fails unless every CI job succeeds (https://github.com/ciatlas/flowpact/blob/main/.github/workflows/ci.yml). Renovate merges only when all checks are green. The other checks (CodeQL, code-scanning results) are informational, so merging past a failure in one of them is a manual action by the maintainer.


    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.

    On every pull request, CI's Test job runs the Vitest suite of unit, property and end-to-end tests (pnpm coverage) on Node 22 and 24 (https://github.com/ciatlas/flowpact/blob/main/.github/workflows/ci.yml). CI also smoke-tests the packed CLI on Linux, macOS and Windows and the extension in VS Code. The main ruleset requires the aggregate 'CI passed' check and has no bypass actors, so nothing merges without these tests.


    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.

    https://ciatlas.github.io/flowpact/docs/how-it-works describes the analysis step by step, from YAML to reports. https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#repository-layout names each component: the core model, lint, reporters, CLI/API, action, language server and extension. https://ciatlas.github.io/flowpact/docs/security covers every actor and action around them: the analyzed repository as untrusted input, plugins, what flowpact writes, the Action's two network calls and its token, and permissions. The release workflow, release bot and Renovate are covered there and in https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#releases.


    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.

    Reference docs cover every external interface of the released assets. The CLI's commands, options, output formats, JSON report, exit codes and environment variables: https://ciatlas.github.io/flowpact/docs/cli. The Action's inputs, outputs, annotations and permissions: https://ciatlas.github.io/flowpact/docs/action. The programmatic API: https://ciatlas.github.io/flowpact/docs/api. The config, with JSON Schemas: https://ciatlas.github.io/flowpact/docs/configuration. Contracts: https://ciatlas.github.io/flowpact/docs/contracts. The plugin API: https://ciatlas.github.io/flowpact/docs/custom-rules. The language server and extension settings: https://ciatlas.github.io/flowpact/docs/editors.


    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.

    The threat model at https://ciatlas.github.io/flowpact/docs/threat-model ranks the most likely and impactful security problems by residual risk, each with the mitigation in the code, the tests that cover it and the risk that remains; CONTRIBUTING.md asks to revisit it for new features and breaking changes.


    Suficiente para um badge!

    A documentação do projeto DEVE incluir uma política de 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.

    https://github.com/ciatlas/flowpact/blob/main/SECURITY.md is the coordinated disclosure policy, also shown at https://github.com/ciatlas/flowpact/security/policy. Reports go privately through GitHub's private vulnerability reporting, with an acknowledgement within 3 working days and an assessment within 10. The advisory is published once a fixed release is available, crediting the reporter.


    Suficiente para um badge!

    A documentação do projeto DEVE fornecer um meio de relatar vulnerabilidades de forma privada diretamente aos contatos de segurança 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.

    https://github.com/ciatlas/flowpact/blob/main/SECURITY.md#reporting-a-vulnerability directs reporters to GitHub's private vulnerability reporting form (https://github.com/ciatlas/flowpact/security/advisories/new) and not to public issues. The form is enabled for the repository, and reports reach the maintainer privately.


    Suficiente para um badge!

    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.

    Vulnerabilities fixed in past releases are published in https://github.com/ciatlas/flowpact/blob/main/SECURITY.md#security-fixes-in-past-releases with the affected versions, how to tell whether you are affected and the fix; future ones are published as GitHub security advisories (https://github.com/ciatlas/flowpact/security/advisories) and named in the release notes.



Você pode usar ferramentas e sistemas de IA para propor alterações por meio de uma URL simples, como https://www.bestpractices.dev/pt-BR/projects/15403/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. Veja nosso sistema de propostas de automação para saber como fazer isso. 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 Ruman Kazi e aos contribuidores do selo de melhores práticas OpenSSF.

Entrada de selo do projeto de propriedade de: Ruman Kazi.
Entrada criada em 2026-10-12 07:45:57 UTC, última atualização em 2026-10-12 10:15:42 UTC. Selo de aprovação alcançado pela última vez em 2026-10-12 07:46:35 UTC.