treestamp

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


Estes são os critérios de Nível Básico 3. 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.

    An editor for creating and maintaining directory trees for project documentation

    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 20/21 ●

  • Controles


    Suficiente para um badge!

    Quando um trabalho recebe permissões em um pipeline de CI/CD, o código-fonte ou configuração DEVE atribuir apenas os privilégios mínimos necessários para a atividade correspondente. [OSPS-AC-04.02]
    Configure os pipelines de CI/CD do projeto para atribuir as menores permissões disponíveis a usuários e serviços por padrão, elevando as permissões apenas quando necessário para tarefas específicas. Em alguns sistemas de controle de versão, isso pode ser possível no nível organizacional ou de repositório. Se não, defina permissões no nível superior do pipeline.

    Every workflow sets read-only top-level permissions, and the repository's default workflow token is read-only. Jobs that need more request only what their task requires: id-token: write for PyPI Trusted Publishing and Scorecard result publishing, security-events: write for uploading scan results, and contents: write with pull-requests: write for the job that opens README update pull requests. The Release Please job uses a GitHub App token limited to the contents, issues, and pull-request write access it needs: https://github.com/reponomics/treestamp/tree/main/.github/workflows.


    Suficiente para um badge!

    Os pipelines de CI/CD que aceitam entradas de colaboradores confiáveis DEVEM sanitizar e validar essas entradas antes de usá-las no pipeline. [OSPS-BR-01.04]
    Os pipelines de CI/CD devem sanitizar (citar, escapar ou sair com valores esperados) todas as entradas de colaboradores em execuções explícitas de workflow. Embora os colaboradores sejam geralmente confiáveis, as entradas manuais em um workflow não podem ser revisadas e podem ser abusadas por uma tomada de conta ou ameaça interna.

    Workflows validate collaborator input before use. The deployment revision (deploy.yml) and README update branch (treestamp-update.yml) must match a ref-shaped pattern, and the release tag (publish.yml) must be vX.Y.Z, match the package versions, and point to a commit on main. None of these values is interpolated into a shell script: https://github.com/reponomics/treestamp/tree/main/.github/workflows.


    Suficiente para um badge!

    Quando um lançamento oficial for criado, todos os ativos dentro desse lançamento DEVEM estar claramente associados ao identificador de lançamento ou outro identificador único para o ativo. [OSPS-BR-02.02]
    Atribua um identificador de versão único a cada ativo de software produzido pelo projeto, seguindo uma convenção de nomenclatura ou esquema de numeração consistente. Exemplos incluem SemVer, CalVer ou id de commit do git.

    Each release's wheel and source distribution on PyPI include the release version in their file names, such as treestamp-0.1.1-py3-none-any.whl and treestamp-0.1.1.tar.gz: https://pypi.org/project/treestamp/#files. GitHub Releases have no uploaded assets; their only files are the source archives GitHub generates from each version tag.


    Suficiente para um badge!

    O projeto DEVE definir uma política para gerenciar segredos e credenciais usadas pelo projeto. A política deve incluir diretrizes para armazenar, acessar e rotacionar segredos e credenciais. [OSPS-BR-07.02]
    Documente como segredos e credenciais são gerenciados e usados dentro do projeto. Isso deve incluir detalhes sobre como os segredos são armazenados (por exemplo, usando uma ferramenta de gerenciamento de segredos), como o acesso é controlado e como os segredos são rotacionados ou atualizados. Certifique-se de que informações sensíveis não sejam codificadas diretamente no código-fonte ou armazenadas em sistemas de controle de versão.

    MAINTENANCE.md defines the policy for secrets and credentials: they are stored only in the services that use them, only the maintainer can access them, workflows receive them only in the jobs that need them, and they are rotated immediately on suspected exposure and whenever the people with access change: https://github.com/reponomics/treestamp/blob/main/docs/MAINTENANCE.md#secrets-and-credentials.


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, a documentação do projeto DEVE conter instruções para verificar a integridade e autenticidade dos ativos de lançamento. [OSPS-DO-03.01]
    As instruções no projeto devem conter informações sobre a tecnologia usada, os comandos a serem executados e a saída esperada. Quando possível, evite armazenar essa documentação no mesmo local que o pipeline de construção e lançamento para evitar que uma única violação comprometa tanto o software quanto a documentação para verificar a integridade do software.

    The release verification guide explains how to check each PyPI file's PEP 740 attestation with pypi-attestations, with the commands to run and the expected output for verified and failing files: https://github.com/reponomics/treestamp/blob/main/docs/verifying-releases.md#verify-a-file.


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, a documentação do projeto DEVE conter instruções para verificar a identidade esperada da pessoa ou processo que criou o lançamento de software. [OSPS-DO-03.02]
    A identidade esperada pode estar na forma de IDs de chave usados para assinar, emissor e identidade de um certificado sigstore ou outras formas similares. Quando possível, evite armazenar essa documentação no mesmo local que o pipeline de construção e lançamento para evitar que uma única violação comprometa tanto o software quanto a documentação para verificar a integridade do software.

    The release verification guide lists the Sigstore certificate identity expected on every release file: the GitHub Actions OIDC issuer, the reponomics/treestamp repository, and the publish.yml workflow at the release tag. It also shows how to check the publisher that PyPI recorded for each file: https://github.com/reponomics/treestamp/blob/main/docs/verifying-releases.md#expected-publisher-identity.


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, a documentação do projeto DEVE incluir uma declaração descritiva sobre o escopo e a duração do suporte para cada lançamento. [OSPS-DO-04.01]
    Para comunicar o escopo e a duração do suporte para os ativos de software lançados pelo projeto, o projeto deve ter um arquivo SUPPORT.md, uma seção "Support" em SECURITY.md ou outra documentação explicando o ciclo de vida do suporte, incluindo a duração esperada de suporte para cada lançamento, os tipos de suporte fornecidos (por exemplo, correções de bugs, atualizações de segurança) e quaisquer políticas ou procedimentos relevantes para obter suporte.

    SECURITY.md states that each release is supported until the next release is published, and that support covers bug and security fixes delivered in a new release, with no long-term support for older versions. Vulnerabilities are reported privately as SECURITY.md describes, and ordinary bugs through GitHub issues: https://github.com/reponomics/treestamp/blob/main/.github/SECURITY.md#supported-versions.


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, a documentação do projeto DEVE fornecer uma declaração descritiva de quando lançamentos ou versões não receberão mais atualizações de segurança. [OSPS-DO-05.01]
    Para comunicar o escopo e a duração do suporte para correções de segurança, o projeto deve ter um SUPPORT.md ou outra documentação explicando a política do projeto para atualizações de segurança.

    SECURITY.md states that once a newer release exists, earlier releases receive no further updates, including security updates: https://github.com/reponomics/treestamp/blob/main/.github/SECURITY.md#supported-versions.


    Suficiente para um badge!

    A documentação do projeto DEVE ter uma política de que os colaboradores de código sejam revisados antes de conceder permissões elevadas a recursos sensíveis. [OSPS-GV-04.01]
    Publique uma política aplicável na documentação do projeto que exija que colaboradores de código sejam revisados e aprovados antes de receberem permissões elevadas a recursos sensíveis, como aprovação de merge ou acesso a segredos. É recomendado que a verificação inclua estabelecer uma linhagem justificável de identidade, como confirmar a associação do contribuidor com uma organização confiável conhecida.

    GOVERNANCE.md states that access to sensitive resources is granted only by the maintainer, after considering the person's prior contributions, commitment, and availability, that it is limited to what their role requires, and that changes are recorded in GOVERNANCE.md: https://github.com/reponomics/treestamp/blob/main/docs/GOVERNANCE.md#decisions-and-changes-to-access.


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, todos os ativos de software compilados lançados DEVEM ser entregues com uma lista de materiais de software. [OSPS-QA-02.02]
    É recomendado gerar automaticamente SBOMs no momento da compilação usando uma ferramenta que foi verificada quanto à precisão. Isso permite que os usuários ingiram esses dados de forma padronizada junto com outros projetos em seu ambiente.

    The released wheel and source distribution contain only Python source and package data; the project releases no compiled assets. The hosted editor's container image is deployed to the project's own hosting and is not distributed as a release asset.


    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento compreendendo múltiplos repositórios de código-fonte, todos os subprojetos DEVEM impor requisitos de segurança que sejam tão rigorosos ou mais rigorosos que a base de código principal. [OSPS-QA-04.02]
    Quaisquer repositórios de código de subprojeto adicionais produzidos pelo projeto e compilados em um lançamento devem impor requisitos de segurança conforme aplicável ao status e intenção da respectiva base de código. Além de seguir os requisitos correspondentes da Linha de Base OSPS, isso pode incluir exigir uma revisão de segurança, garantir que esteja livre de vulnerabilidades e garantir que esteja livre de problemas de segurança conhecidos.

    Releases are built from this single repository, which also contains the hosted editor in web/; no other repository contributes to them.


    Suficiente para um badge!

    A documentação do projeto DEVE documentar claramente quando e como os testes são executados. [OSPS-QA-06.02]
    Adicione uma seção à documentação de contribuição que explique como executar os testes localmente e como executar os testes no pipeline de CI/CD. A documentação deve explicar o que os testes estão testando e como interpretar os resultados.

    CONTRIBUTING describes the local test commands, what the core, hosted-editor, browser, and JavaScript suites cover, that CI runs them on every pull request to and push to main, and how to read a failing check: https://github.com/reponomics/treestamp/blob/main/.github/CONTRIBUTING.md#check-changes.


    Suficiente para um badge!

    A documentação do projeto DEVE incluir uma política de que todas as mudanças importantes no software produzido pelo projeto devem adicionar ou atualizar testes da funcionalidade em um conjunto de testes automatizado. [OSPS-QA-06.03]
    Adicione uma seção à documentação de contribuição que explique a política para adicionar ou atualizar testes. A política deve explicar o que constitui uma mudança importante e quais testes devem ser adicionados ou atualizados.

    CONTRIBUTING requires non-trivial changes to add or update automated tests in the same pull request. Tests belong in the suite that covers the changed area and should assert the changed behavior. Changes that leave behavior unchanged, such as documentation, refactoring already covered by tests, and dependency updates that pass the suites, need no new tests: https://github.com/reponomics/treestamp/blob/main/.github/CONTRIBUTING.md#tests-for-changes.


    Informações obrigatórias desconhecidas, insuficiente para um badge.

    Quando um commit for feito no branch principal, o sistema de controle de versão do projeto DEVE exigir pelo menos uma aprovação humana não-autora das mudanças antes do merge. [OSPS-QA-07.01]
    Configure o sistema de controle de versão do projeto para exigir pelo menos uma aprovação humana não-autora das mudanças antes de fazer merge no branch de lançamento ou principal. Isso pode ser alcançado exigindo que um pull request seja revisado e aprovado por pelo menos um outro colaborador antes que possa ser feito o merge.

    Suficiente para um badge!

    Quando o projeto tiver feito um lançamento, o projeto DEVE realizar uma modelagem de ameaças e análise de superfície de ataque para entender e proteger contra ataques em caminhos de código críticos, funções e interações dentro do sistema. [OSPS-SA-03.02]
    Modelagem de ameaças é uma atividade onde o projeto analisa a base de código, processos e infraestrutura associados, interfaces, componentes-chave e "pensa como um hacker" e faz um brainstorming de como o sistema pode ser quebrado ou comprometido. Cada ameaça identificada é listada para que o projeto possa então pensar em como evitar proativamente ou fechar quaisquer lacunas/vulnerabilidades que possam surgir. Certifique-se de que isso seja atualizado para novos recursos ou mudanças críticas.

    The security assessment lists the entry points for untrusted input, the code that first handles each, and the critical code paths. It analyzes threats to the hosted editor, the command-line tool and terminal editor, and the supply chain and release process, with measures and remaining risks. It is revised when a change adds an interface, actor, credential, or kind of stored or transmitted data: https://github.com/reponomics/treestamp/blob/main/docs/security-assessment.md.


    Suficiente para um badge!

    Quaisquer vulnerabilidades nos componentes de software que não afetem o projeto DEVEM ser registradas em um documento VEX, complementando o relatório de vulnerabilidade com detalhes de não explorabilidade. [OSPS-VM-04.02]
    Estabeleça um feed VEX comunicando o status de explorabilidade de vulnerabilidades conhecidas, incluindo detalhes de avaliação ou quaisquer mitigações em vigor impedindo que código vulnerável seja executado.

    SECURITY.md requires that a vulnerability in a dependency of the released package that does not affect treestamp be recorded in the OpenVEX document vex/treestamp.openvex.json before the finding is suppressed. Each record gives the affected treestamp versions, the status not_affected, a justification, and an explanation. No vulnerability has needed a statement yet, so the document has not been created; https://github.com/reponomics/treestamp/blob/main/vex/treestamp.openvex.example.json shows the format: https://github.com/reponomics/treestamp/blob/main/.github/SECURITY.md#dependency-and-code-scanning-findings.


    Suficiente para um badge!

    A documentação do projeto DEVE incluir uma política que defina um limite para a correção de descobertas de SCA relacionadas a vulnerabilidades e licenças. [OSPS-VM-05.01]
    Documente uma política no projeto que defina um limite para remediação de descobertas de SCA relacionadas a vulnerabilidades e licenças. Inclua o processo para identificar, priorizar e remediar essas descobertas.

    SECURITY.md sets remediation deadlines for dependency vulnerability findings by severity: critical and high before the next release and within 30 days, medium within 90 days, and low at the maintainer's discretion. CONTRIBUTING requires each dependency's license to be in the dependency scan's allowlist, or to have an exception recorded after the maintainer's review. A dependency that violates this is replaced or removed before the next release: https://github.com/reponomics/treestamp/blob/main/.github/SECURITY.md#dependency-and-code-scanning-findings, https://github.com/reponomics/treestamp/blob/main/.github/CONTRIBUTING.md#dependencies.


    Suficiente para um badge!

    A documentação do projeto DEVE incluir uma política para tratar violações de SCA antes de qualquer lançamento. [OSPS-VM-05.02]
    Documente uma política no projeto para abordar os resultados aplicáveis de Análise de Composição de Software antes de qualquer lançamento, e adicione verificações de status que confirmem a conformidade com essa política antes do lançamento.

    SECURITY.md states that no release is published while a critical or high dependency finding or a dependency license violation is open: https://github.com/reponomics/treestamp/blob/main/.github/SECURITY.md#dependency-and-code-scanning-findings.


    Suficiente para um badge!

    Todas as mudanças na base de código do projeto DEVEM ser avaliadas automaticamente em relação a uma política documentada para dependências maliciosas e vulnerabilidades conhecidas em dependências, e então bloqueadas em caso de violações, exceto quando declaradas e suprimidas como não exploráveis. [OSPS-VM-05.03]
    Crie uma verificação de status no sistema de controle de versão do projeto que execute uma ferramenta de Análise de Composição de Software em todas as alterações na base de código. Exija que a verificação de status seja aprovada antes que as alterações possam ser mescladas.

    Every pull request to main runs OSV-Scanner on the locked dependencies, and the default-branch ruleset requires that check to pass before merging, with no bypass actors. The check fails on any known vulnerability, including malicious-package advisories. Under SECURITY.md, a finding that does not affect treestamp may be suppressed only through an osv-scanner.toml entry with a recorded reason: https://github.com/reponomics/treestamp/blob/main/.github/workflows/osv-scanner.yml, https://github.com/reponomics/treestamp/blob/main/.github/SECURITY.md#dependency-and-code-scanning-findings.


    Suficiente para um badge!

    A documentação do projeto DEVE incluir uma política que defina um limite para a correção de descobertas de SAST. [OSPS-VM-06.01]
    Documente uma política no projeto que defina um limite para remediação de resultados de Teste de Segurança de Aplicação Estática (SAST). Inclua o processo para identificar, priorizar e remediar esses resultados.

    SECURITY.md sets remediation deadlines for CodeQL findings by severity: critical and high before the next release and within 30 days, medium within 90 days, and low at the maintainer's discretion: https://github.com/reponomics/treestamp/blob/main/.github/SECURITY.md#dependency-and-code-scanning-findings.


    Suficiente para um badge!

    Todas as mudanças na base de código do projeto DEVEM ser avaliadas automaticamente em relação a uma política documentada para vulnerabilidades de segurança e bloqueadas em caso de violações, exceto quando declaradas e suprimidas como não exploráveis. [OSPS-VM-06.02]
    Crie uma verificação de status no sistema de controle de versão do projeto que execute uma ferramenta de Teste de Segurança de Aplicação Estática (SAST) em todas as alterações na base de código. Exija que a verificação de status seja aprovada antes que as alterações possam ser mescladas.

    CodeQL analyzes every pull request, and the default-branch ruleset requires its results before merging and blocks merging on security alerts of high severity or above and on error-level alerts. Under SECURITY.md, a finding that does not affect treestamp may be suppressed only by dismissing the alert with a recorded reason: https://github.com/reponomics/treestamp/blob/main/.github/SECURITY.md#dependency-and-code-scanning-findings.



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/15900/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 reponomics-dev e aos contribuidores do selo de melhores práticas OpenSSF.

Entrada de selo do projeto de propriedade de: reponomics-dev.
Entrada criada em 2026-10-25 12:10:45 UTC, última atualização em 2026-10-30 12:00:00 UTC. Selo de aprovação alcançado pela última vez em 2026-10-30 10:21:54 UTC.