MkDocs Source Links

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


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

    MkDocs plugin that keeps ](../path) links clickable in your IDE and on GitHub while rewriting them to forge blob/tree URLs in built HTML only.

    Problem: Docs in docs/ often link to repo files via relative paths (../src/...). Those paths work in source viewers and editors, but break in a published MkDocs site. This plugin fixes published links without changing your markdown.

    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.

    Justification: Every workflow sets explicit least-privilege permissions at workflow and job scope. CI/docs/scorecards use contents: read only; publish grants id-token: write for OIDC and contents: write only on jobs that upload release assets or SLSA provenance; Pages deploy adds pages: write only on the deploy job.
    URLs:


    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.

    Justification: No CI/CD pipeline accepts manual collaborator input. All workflows are triggered by push, pull_request, tag push, or schedule only — there are no workflow_dispatch inputs or other explicit manual-input triggers to sanitize.
    URLs:


    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.

    Justification: Each release tag (e.g. v0.4.0) bundles assets whose names embed the version: mkdocs_source_links-0.4.0-py3-none-any.whl, mkdocs_source_links-0.4.0.tar.gz, and SLSA provenance mkdocs-source-links.intoto.jsonl tied to that tag’s artifact hashes. The same version appears in pyproject.toml, git tag, PyPI, and GitHub Release.
    URLs:


    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.

    Justification: SECURITY.md documents how secrets and credentials are stored (GitHub encrypted secrets), accessed (maintainers only), rotated (signing keys via GitHub; OIDC for PyPI with no long-lived tokens), and prohibited from source control.
    URLs:


    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.

    Justification: Consumer-facing release integrity verification instructions (slsa-verifier commands and expected output) are published at docs/security.md, separate from pipeline config.
    URLs:


    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.

    Justification: docs/security.md documents how to verify release author identity via GitHub-verified signed annotated tags and SLSA provenance builder/source fields.
    URLs:


    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.

    Justification: SUPPORT.md documents support scope and duration per release (latest only), channels (GitHub Issues), Python/MkDocs platform support, and cross-links security support policy.
    URLs:


    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.

    Justification: SECURITY.md documents when releases stop receiving security updates: only the latest released version is supported; older versions do not receive security fixes. Vulnerability reporting and fix release expectations are also documented (14-day initial response, fix in a new version).
    URLs:


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE ter uma política de que 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.

    Justification: MAINTAINERS.md publishes an escalated-permissions policy: contributors do not receive sensitive access by default; future grants require vetting, documentation, and a merged PR updating the maintainers table.
    URLs:


    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.

    Justification: Each release attaches a CycloneDX 1.5 SBOM (mkdocs-source-links-X.Y.Z.cdx.json) listing runtime dependencies from uv.lock, uploaded alongside wheel, sdist, and SLSA provenance.
    URLs:


    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.

    Justification: The project is a single repository and PyPI package. Releases are built entirely from this one codebase; there are no additional subproject repositories compiled into the release that would need separate security requirement enforcement.
    URLs:


    Suficiente para um badge!

    Enquanto ativo, 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.

    Justification: CONTRIBUTING.md documents running tests locally (make test, make ci, uv run pytest --cov) and notes that CI runs the same suite on every PR/push to main (Python 3.10–3.13 plus Windows/macOS smoke jobs). The tests/ suite covers link rewriting, forge URL generation, branch resolution, anchors, integration builds, and release tooling; CI fails if coverage drops below 100%.
    URLs:


    Suficiente para um badge!

    Enquanto ativo, 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 automatizados. [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.

    Justification: Policy is explicit: every change must keep the suite at 100% coverage (CONTRIBUTING.md step 2). The PR template requires confirming tests were added/updated. Major functional changes to the plugin (rewrite logic, forge URLs, config) require corresponding tests in tests/ — enforced by coverage gate and review.
    URLs:


    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.

    Justification: Single-maintainer project. External contributor PRs receive maintainer (non-author) review, but maintainer-authored PRs cannot satisfy non-author human approval without a second trusted reviewer. GitHub branch protection requires one review but does not block author self-approval.
    URLs:


    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.

    Justification: SECURITY.md includes a security assessment with trust boundaries (doc author, MkDocs, plugin, forges), attack surface (filesystem reads, markdown link parsing, URL generation — no network I/O at runtime), identified threats with mitigations, and residual risks. This is maintained project documentation updated with security-relevant releases.
    URLs:


    Suficiente para um badge!

    Enquanto ativo, quaisquer vulnerabilidades nos componentes de software que não afetam o projeto DEVEM ser contabilizadas em um documento VEX, aumentando 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.

    Justification: No VEX document exists because there are no published vulnerabilities or dependency CVEs requiring exploitability triage for this project. When SCA findings or advisories arise, a VEX feed or documented triage process would be added; currently none is needed.
    URLs:


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir uma política que defina um limite para remediaçã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.

    Justification: SECURITY.md documents SCA remediation thresholds (block Critical/High CVEs), license policy (OSI-approved/MIT-compatible), and triage process via pip-audit CI and Dependabot.
    URLs:


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir uma política para abordar 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.

    Justification: Policy requires addressing SCA violations before release; make release-prep runs make ci (including pip-audit) before opening a release PR.
    URLs:


    Suficiente para um badge!

    Enquanto ativo, todas as alterações na base de código do projeto DEVEM ser automaticamente avaliadas 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.

    Justification: pip-audit runs in a dedicated audit CI job on every PR and push to main; merge is blocked once audit is a required status check.
    URLs:


    Suficiente para um badge!

    Enquanto ativo, a documentação do projeto DEVE incluir uma política que defina um limite para remediação de resultados 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.

    Justification: Policy is zero-tolerance: all SAST findings block merge and release. Pre-commit and CI run ruff (including bandit S rules), mypy, pylint, and pydoclint; any failure stops the lint job, which is a required status check. make release-prep runs full make ci before a release PR is opened.
    URLs:


    Suficiente para um badge!

    Enquanto ativo, todas as alterações na base de código do projeto DEVEM ser automaticamente avaliadas em relação a uma política documentada para fraquezas 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.

    Justification: SAST runs automatically on every PR and push to main via the required lint CI job (ruff/bandit, mypy, pylint, pydoclint through pre-commit). Merge is blocked unless lint passes. CodeQL also runs on PRs/push/schedule as supplementary analysis. Suppressions are limited and explicit (e.g. test-only ruff per-file ignores in pyproject.toml).
    URLs:



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 Filip Christiansen e aos contribuidores do selo de melhores práticas OpenSSF.

Entrada de selo do projeto de propriedade de: Filip Christiansen.
Entrada criada em 2026-06-18 15:04:02 UTC, última atualização em 2026-06-19 12:04:16 UTC. Selo de aprovação alcançado pela última vez em 2026-06-18 18:12:08 UTC.