bookstack-mcp

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

    BookStack stores your team's knowledge — but AI assistants can't access it without an integration. BookStack MCP Server bridges that gap, connecting AI assistants (Claude Desktop, LibreChat, and any MCP-compatible client) directly to your BookStack instance so they can search, read, and manage your documentation through natural language.

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

  • Controles


    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.

    All CI/CD workflows use a read-all or contents: read baseline with per-job permission overrides granting only what each job requires. The one over-privileged case (verify job having packages: write when it only inspects images) was corrected to packages: read in PR #73. Write permissions (packages: write, contents: write, security-events: write) are scoped only to the specific jobs that need them.



    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.

    The pipelines do not interpolate user-controlled strings (branch names, commit messages, PR titles) directly into shell run: steps. Dynamic values used in shell steps are either integers (PR number), file-sourced (version from package.json via jq), or GitHub-controlled identifiers (github.repository, github.actor). StepSecurity harden-runner is applied to all jobs.



    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.

    All release assets are tagged with the version identifier vX.Y.Z derived from packages/stdio/package.json:

    GitHub Release is created with the exact git tag (vX.Y.Z) as both the release name and tag ref
    Docker images are published with :X.Y.Z, :X.Y, and :X tags in addition to :latest, ensuring the exact version is always addressable
    SLSA Level 2 provenance attestations are attached to the specific image digest at build time, cryptographically binding each image to the commit and build run that produced it
    The git tag is only created after the registry manifest is verified, so the tag always corresponds to a confirmed published image



    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.

    SECURITY.md contains a "Secrets and Credentials Policy" section documenting storage (env vars only, .gitignore, never hardcoded), access (dedicated least-privilege BookStack user, separate tokens per environment), rotation (immediately on exposure, recommended 90-day cadence, revoke old tokens promptly), CI/CD secrets (none manually stored; only auto-provisioned short-lived GITHUB_TOKEN), and incident response (rotate first, then report privately).



    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 README Verifying releases section documents how to verify Docker image provenance attestations using gh attestation verify (by tag and by digest), confirming the image was built by the official pipeline from this repository. It also documents git tag --verify for signed source tags.



    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 README Verifying releases section documents two methods for verifying authorship identity:

    gh attestation verify confirms the image was built by a GitHub Actions workflow running under the paradoxbound organisation — cryptographically binding the release to the repository owner's identity
    git tag --verify verifies the SSH signature on the git tag against the signing key registered to the paradoxbound GitHub account



    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 contains a "Supported Versions" section stating that only the latest release (2.6.x) is actively maintained with security updates, and all prior versions (< 2.6) are unsupported. This defines both scope (security updates) and duration (latest release only) of support.



    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: "Only the latest release is actively maintained with security updates." The Supported Versions table marks all versions below 2.6.x as unsupported. This makes the end-of-support condition explicit: a release stops receiving security updates as soon as a newer release is published.



    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.

    MAINTAINERS.md contains an "Adding collaborators" section documenting the four-step review process required before escalated permissions are granted: verified contribution track record, identity verification, explicit approval from @paradoxbound, and least-privilege scoping. This policy applies to all sensitive resource access listed in the document.



    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 project produces Docker images as its compiled release assets. Starting from v2.6.1, every Docker image release is accompanied by a Software Bill of Materials (SBOM) in SPDX JSON format (sbom.spdx.json), generated by anchore/sbom-action using Syft and attached as an asset to the corresponding GitHub Release. Users can download it with gh release download vX.Y.Z --pattern 'sbom.spdx.json'. The release pipeline validates SBOM generation on every PR via a smoke test in the pre-merge CD check job.



    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.

    This project is a single-repository monorepo (packages/core + packages/stdio). There are no separate source code repositories involved in producing a release — both packages live in github.com/paradoxbound/bookstack-mcp and are built, tested, and released together by the same CI/CD pipeline. The criterion is marked N/A.



    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.

    The README Testing section documents both when and how tests are run. Tests run automatically on every pull request and every push to main via the Functional Tests GitHub Actions workflow. Locally, tests are run with npm test after setting TEST_BOOKSTACK_URL, TEST_BOOKSTACK_TOKEN_ID, and TEST_BOOKSTACK_TOKEN_SECRET. The section also describes test behaviour: self-seeding, automatic cleanup, and graceful skip when credentials are absent.



    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.

    CONTRIBUTING.md step 2 in "Making changes" explicitly states: "any change that adds or modifies functionality should include corresponding tests in the automated test suite (packages/core/tests/)". This policy applies to all contributors as part of the documented contribution workflow.



    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.

    The project's primary branch is protected by a branch protection rule requiring at least one approving review from a non-author collaborator before any pull request can be merged. This is enforced for all users including repository administrators, with no bypass permitted.



    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 project's SECURITY.md contains a 'Threat Model and Attack Surface Analysis' section documenting trust boundaries, entry points, and critical code paths, with six identified threats rated by severity and their mitigations. The section notes it is reviewed and updated at each release.



    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.

    A VEX document (vex.json) in OpenVEX format is maintained at the repository root. When vulnerability scanners report CVEs in dependencies that do not affect the deployed product, statements are added with machine-readable justifications. Trivy reads the VEX document automatically during both PR and release scans to suppress confirmed non-applicable findings."



    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.

    SECURITY.md includes a 'Vulnerability and License Remediation Policy' section defining severity thresholds (CRITICAL blocks release, HIGH must be resolved within 30 days, MEDIUM/LOW addressed via Dependabot) and a license policy requiring OSI-approved permissive licenses for all runtime dependencies.



    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.

    SECURITY.md explicitly states that no release may be published while any unresolved CRITICAL or HIGH severity SCA finding remains open. CRITICAL findings are blocked by the Trivy release gate and HIGH findings are blocked by the npm audit CI gate, both of which must pass before a release can proceed.



    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.

    SECURITY.md documents the automated dependency evaluation pipeline that runs on every PR and push to main: npm audit blocks on HIGH/CRITICAL and malicious package advisories, OSV Scanner blocks on any OSV advisory match including malicious packages, Trivy blocks on CRITICAL in the Docker image, and GitHub Dependency Review blocks on new vulnerable or malicious dependencies introduced by a PR. Confirmed non-exploitable findings may be suppressed via vex.json.



    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.

    SECURITY.md includes a 'SAST Policy' section defining remediation thresholds: error-level (HIGH/CRITICAL) CodeQL findings block merge; warning-level (MEDIUM) and note-level (LOW) findings are reported to the GitHub Security tab on a best-effort basis.



    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.

    CodeQL runs automatically on every PR and push to main. The workflow fails with exit code 1 if any error-level finding is found in the SARIF output, and CodeQL is a required branch protection check — PRs cannot merge while the check fails. False positives may be suppressed inline with a documented justification.



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

Entrada de selo do projeto de propriedade de: Jim Bailey.
Entrada criada em 2026-03-08 10:20:21 UTC, última atualização em 2026-03-10 14:13:23 UTC. Selo de aprovação alcançado pela última vez em 2026-03-10 14:13:23 UTC.