Palimpsests

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 na página do seu projeto! O status do selo se parece com isto: O nível do selo para o projeto 13534 é gold Aqui está como incorporá-lo:
Você pode mostrar o status do seu selo incorporando isto no seu arquivo markdown:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13534/badge)](https://www.bestpractices.dev/projects/13534)
ou incorporando isto no seu HTML:
<a href="https://www.bestpractices.dev/projects/13534"><img src="https://www.bestpractices.dev/projects/13534/badge"></a>


Estes são os critérios de nível Prata. Você também pode visualizar os critérios de nível Aprovação ou Ouro.

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

        

 Fundamentos 17/17

  • Geral

    Observe que outros projetos podem usar o mesmo nome.

    Layered local-LLM inference engine for agentic workloads: Ollama and llama.cpp behind one abstraction, context-memory (sink/window/evict + block retrieval), encrypted audit log. Native L3 serving layer in progress.

    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.
  • Pré-requisitos


    O projeto DEVE alcançar um distintivo de nível aprovado. [achieve_passing]

  • Conteúdo básico do site do projeto


    As informações sobre como contribuir DEVEM incluir os requisitos para contribuições aceitáveis (por exemplo, uma referência a qualquer padrão de codificação obrigatório). (URL obrigatória) [contribution_requirements]

    CONTRIBUTING.md states the requirements for acceptable contributions explicitly. It defines ground rules (don't break the engine abstraction, don't modify the attention kernel), the required workflow (branch, pull request, green CI on all three platforms before merge), and a dedicated Code Style section specifying the coding standard: ruff with ["E","F","I","B","UP"], line length 100, target py311, type hints on public functions, English comments, and a tests-with-every-change policy. URL: https://github.com/Assault-Consulting/Palimpsests/blob/main/CONTRIBUTING.md


  • Supervisão do projeto


    O projeto DEVERIA ter um mecanismo legal onde todos os desenvolvedores de quantidades não triviais de software do projeto afirmem que estão legalmente autorizados a fazer essas contribuições. A abordagem mais comum e facilmente implementada para fazer isso é usando um Developer Certificate of Origin (DCO), onde os usuários adicionam "signed-off-by" em seus commits e o projeto faz link para o site do DCO. No entanto, isso PODE ser implementado como um Contributor License Agreement (CLA) ou outro mecanismo legal. (URL obrigatória) [dco]
    O DCO é o mecanismo recomendado porque é fácil de implementar, rastreado no código-fonte e o git suporta diretamente um recurso "signed-off" usando "commit -s". Para ser mais eficaz, é melhor que a documentação do projeto explique o que "signed-off" significa para aquele projeto. Um CLA é um acordo legal que define os termos sob os quais obras intelectuais foram licenciadas para uma organização ou projeto. Um contributor assignment agreement (CAA) é um acordo legal que transfere direitos em uma obra intelectual para outra parte; os projetos não são obrigados a ter CAAs, já que ter CAA aumenta o risco de que contribuidores potenciais não contribuam, especialmente se o receptor for uma organização com fins lucrativos. Os CLAs da Apache Software Foundation (a licença de contribuidor individual e o CLA corporativo) são exemplos de CLAs, para projetos que determinam que os riscos desses tipos de CLAs para o projeto são menores do que seus benefícios.

    The project uses the Developer Certificate of Origin (DCO). Every commit MUST carry a Signed-off-by: line matching the commit author (real name and reachable email), added with git commit -s; this line is the contributor's DCO certification that they have the legal right to submit the contribution. The requirement, the exact command, and how to fix a missing sign-off (git commit --amend -s, git rebase --signoff <base>) are documented in CONTRIBUTING.md. No separate CLA is used.
    https://developercertificate.org/
    Supporting evidence URL in the repo
    https://github.com/Assault-Consulting/Palimpsests/blob/main/CONTRIBUTING.md



    O projeto DEVE definir e documentar claramente seu modelo de governança do projeto (a forma como toma decisões, incluindo papéis-chave). (URL obrigatória) [governance]
    É necessário haver alguma forma bem estabelecida e documentada de tomar decisões e resolver disputas. Em projetos pequenos, isso pode ser tão simples quanto "o proprietário do projeto e líder toma todas as decisões finais". Existem vários modelos de governança, incluindo ditador benevolente e meritocracia formal; para mais detalhes, consulte Modelos de governança. Tanto abordagens centralizadas (por exemplo, mantenedor único) quanto descentralizadas (por exemplo, grupo de mantenedores) foram usadas com sucesso em projetos. As informações de governança não precisam documentar a possibilidade de criar um fork do projeto, já que isso é sempre possível para projetos FLOSS.

    The project's governance model is defined in docs/GOVERNANCE.md. It documents the roles and their responsibilities (maintainers hold merge rights, review pull requests, and cut releases; the named maintainers and co-maintainer are listed with their duties), and the decision-making process: all changes — code and documentation alike — land via pull request against a branch-protected main, requiring one non-author approval plus green status checks (lint, tests, coverage) before merge. Governance also records continuity/access (two maintainers with repository admin) and openly acknowledges the structural limits of a small maintainer team.
    https://github.com/Assault-Consulting/Palimpsests/blob/main/docs/GOVERNANCE.md



    O projeto DEVE adotar um código de conduta e publicá-lo em um local padrão. (URL obrigatória) [code_of_conduct]
    Os projetos podem ser capazes de melhorar a civilidade de sua comunidade e estabelecer expectativas sobre conduta aceitável adotando um código de conduta. Isso pode ajudar a evitar problemas antes que ocorram e tornar o projeto um lugar mais acolhedor para encorajar contribuições. Isso deve se concentrar apenas no comportamento dentro da comunidade/local de trabalho do projeto. Exemplos de códigos de conduta são o código de conduta do kernel Linux, o Contributor Covenant Code of Conduct, o Código de Conduta Debian, o Código de Conduta Ubuntu, o Código de Conduta Fedora, o Código de Conduta GNOME, o Código de Conduta da Comunidade KDE, o Código de Conduta da Comunidade Python, A Diretriz de Conduta da Comunidade Ruby e O Código de Conduta do Rust.

    The project has adopted a code of conduct, published as CODE_OF_CONDUCT.md in the repository root — one of GitHub's standard, auto-discovered locations for the file. It sets out expected behaviour, unacceptable behaviour, and how to report concerns to the maintainers.
    https://github.com/Assault-Consulting/Palimpsests/blob/main/CODE_OF_CONDUCT.md



    O projeto DEVE definir e documentar publicamente de forma clara os papéis-chave no projeto e suas responsabilidades, incluindo quaisquer tarefas que esses papéis devem executar. DEVE estar claro quem tem qual(is) papel(is), embora isso possa não ser documentado da mesma forma. (URL obrigatória) [roles_responsibilities]
    A documentação para governança e papéis e responsabilidades pode estar em um único lugar.

    Key roles and their responsibilities are publicly documented in docs/GOVERNANCE.md. It defines the maintainer role — hold merge rights, review pull requests, cut releases, administer the repository — and names who holds it: the maintainer (@andreysparish) and the co-maintainer (@olksandrvertel-arch, repository admin; review and hardware benchmarks). The mapping of person → role is explicit in the maintainers table, so it is clear who performs which role, and the duties attached to each are stated alongside.
    https://github.com/Assault-Consulting/Palimpsests/blob/main/docs/GOVERNANCE.md



    O projeto DEVE ser capaz de continuar com interrupção mínima se qualquer pessoa morrer, ficar incapacitada ou, de outra forma, não puder ou não quiser continuar o suporte do projeto. Em particular, o projeto DEVE ser capaz de criar e fechar issues, aceitar mudanças propostas e lançar versões do software, dentro de uma semana após a confirmação da perda de suporte de qualquer indivíduo. Isso PODE ser feito garantindo que outra pessoa tenha quaisquer chaves, senhas e direitos legais necessários para continuar o projeto. Indivíduos que executam um projeto FLOSS PODEM fazer isso fornecendo chaves em um cofre e um testamento fornecendo quaisquer direitos legais necessários (por exemplo, para nomes DNS). (URL obrigatória) [access_continuity]

    The project can continue with minimal disruption if any one contributor becomes unable or unwilling to maintain it. There are two maintainers, both with full repository-admin rights (@andreysparish and @olksandrvertel-arch, per docs/GOVERNANCE.md). Either can independently open and close issues, approve and merge proposed changes, and cut releases — so any one of them stepping away leaves the other able to keep the project running well within a week. Release signing uses GitHub Trusted Publishing (OIDC), which is tied to the repository/organization rather than a single person's private key, so publishing to PyPI does not depend on one individual holding a secret. This continuity — two admins, no single-person bottleneck for review, merge, or release — is documented in GOVERNANCE.md.
    https://github.com/Assault-Consulting/Palimpsests/blob/main/docs/GOVERNANCE.md



    O projeto DEVERIA ter um "bus factor" de 2 ou mais. (URL obrigatória) [bus_factor]
    Um "bus factor" (também conhecido como "truck factor") é o número mínimo de membros do projeto que precisam desaparecer repentinamente de um projeto ("ser atropelados por um ônibus") antes que o projeto pare devido à falta de pessoal conhecedor ou competente. A ferramenta truck-factor pode estimar isso para projetos no GitHub. Para mais informações, consulte Assessing the Bus Factor of Git Repositories de Cosentino et al.

    The project's bus factor is 2. Two people are significant contributors, each able to keep the project going on their own: the maintainer (@andreysparish) and the co-maintainer (@olksandrvertel-arch). Both hold repository-admin rights and can independently review, merge, and release; the co-maintainer has 35+ commits, including the hardware-isolation test suite and the role of independent PALA-1 verifier. Losing either one would not halt the project. Roles and the split of work are documented in docs/GOVERNANCE.md, and the contribution history is visible in the repository.
    URL (required) — the contributors graph is the most direct evidence of a bus factor ≥ 2:
    https://github.com/Assault-Consulting/Palimpsests/graphs/contributors


  • Documentação


    O projeto DEVE ter um roadmap documentado que descreva o que o projeto pretende fazer e não fazer por pelo menos o próximo ano. (URL obrigatória) [documentation_roadmap]
    O projeto pode não alcançar o roadmap, e isso é aceitável; o objetivo do roadmap é ajudar usuários e contribuidores potenciais a entender a direção pretendida do projeto. Não precisa ser detalhado.

    The project maintains a documented roadmap in docs/ROADMAP.md. It states what the project plans to do — a "Working order" of near-term milestones (verifiable audit / the PALA-1 format as the deliverable at 0.7, then assurance tiers B/C at 0.8) — and, explicitly, what it does not plan to do: a "Deferred: sleep-time compute — not scheduled" section that records the idea but rules it out of the current effort, and a "Deferred, with conditions" section listing work that is intentionally not pursued yet and the conditions under which it would be. The horizon spans the coming release cycle (0.6 → 0.7 → 0.8) and beyond, well over the next year, and the document is kept honest about scope rather than aspirational ("subject to revision", measured-not-asserted).
    https://github.com/Assault-Consulting/Palimpsests/blob/main/docs/ROADMAP.md



    O projeto DEVE incluir documentação da arquitetura (também conhecida como design de alto nível) do software produzido pelo projeto. Se o projeto não produz software, selecione "não aplicável" (N/A). (URL obrigatória) [documentation_architecture]
    Uma arquitetura de software explica as estruturas fundamentais de um programa, ou seja, os principais componentes do programa, os relacionamentos entre eles e as principais propriedades desses componentes e relacionamentos.

    The software's high-level architecture is documented in ARCHITECTURE.md at the repository root. It describes the layered design of the engine — a single InferenceEngine abstraction over three interchangeable execution levels (L1 Ollama, L2 llama-server, L3 in-process llama.cpp), with a context-memory layer (window manager + block memory) that runs identically across all levels and lets callers move from level 1 to level 3 without changing code above the engine. The README carries a condensed "Architecture in one screen" section mapping the layers to the providers/ adapters, and the key design decisions behind the level-3 backend are recorded as Architecture Decision Records in docs/adr/ (ADR-0001: level-3 inference backend; ADR-0002: level-3 in-process design and the test boundary).
    https://github.com/Assault-Consulting/Palimpsests/blob/main/ARCHITECTURE.md



    O projeto DEVE documentar o que o usuário pode e não pode esperar em termos de segurança do software produzido pelo projeto (seus "requisitos de segurança"). (URL obrigatória) [documentation_security]
    Estes são os requisitos de segurança que o software deve atender.

    The project documents both what a user can and cannot expect in terms of security. SECURITY.md sets out the security model — the private vulnerability-disclosure process, supported versions, and a mapping of vulnerability classes to the mitigations actually implemented (what the software protects against). What it deliberately does not guarantee is documented just as explicitly: docs/THREAT_MODEL.md defines the threat boundaries and out-of-scope threats, docs/ASSURANCE-CASE.md lays out the assurance argument, and the audit-format specification is unusually direct about limits — its assurance tiers table states, per tier, what each "Proves" and "Does not prove", and a dedicated "What this format does not do" section enumerates the guarantees it does not make (e.g. it proves a record was recorded unmodified, not that the record is true; it does not defend against the device owner at the base tier; it does not bind to hardware without a hardware root of trust). Together these give a user a clear, honest picture of the security requirements — what to rely on and what not to.
    https://github.com/Assault-Consulting/Palimpsests/blob/main/SECURITY.md



    O projeto DEVE fornecer um guia de "início rápido" para novos usuários para ajudá-los a fazer algo rapidamente com o software. (URL obrigatória) [documentation_quick_start]
    A ideia é mostrar aos usuários como começar e fazer o software fazer qualquer coisa. Isso é extremamente importante para que potenciais usuários comecem.

    The project provides a quick-start guide for new users in the README, immediately after installation: a "Quick start" section with copy-paste commands to get going in minutes — talk to a model (prompt via flag or piped over stdin), give a long conversation a smaller context budget so the sink/window/evict path engages, list the models the active engine can see, and inspect or switch engines. It is preceded by a short "Install" section (pip install palimpsests for the base level, plus the extras that enable levels 2 and 3). A fuller usage guide covering the CLI and the Python API, with inputs and outputs, is in docs/USAGE.md.
    https://github.com/Assault-Consulting/Palimpsests#quick-start



    O projeto DEVE fazer um esforço para manter a documentação consistente com a versão atual dos resultados do projeto (incluindo software produzido pelo projeto). Quaisquer defeitos de documentação conhecidos que a tornem inconsistente DEVEM ser corrigidos. Se a documentação estiver geralmente atualizada, mas erroneamente incluir algumas informações antigas que não são mais verdadeiras, trate isso apenas como um defeito, então rastreie e corrija como de costume. [documentation_current]
    A documentação PODE incluir informações sobre diferenças ou mudanças entre versões do software e/ou link para versões antigas da documentação. A intenção deste critério é que um esforço seja feito para manter a documentação consistente, não que a documentação deva ser perfeita.

    The project keeps documentation aligned with the current version of the software, and treats any documentation that has fallen out of date as a defect to be fixed. CONTRIBUTING.md mandates that documentation and tests ship with every behavioral change, so docs move with the code rather than lagging a release. When a stale statement is found, it is corrected like any other defect through the normal pull-request process — for example, a note that still described the project as single-maintainer ("human code review before merge is a solo-project limitation") was corrected once a co-maintainer joined and non-author review became the actual practice. There are no known documentation defects left outstanding; any discovered later are tracked and fixed the same way.



    A página inicial do repositório do projeto e/ou site DEVE identificar e criar hiperlinks para quaisquer conquistas, incluindo este selo de melhores práticas, dentro de 48 horas do reconhecimento público de que a conquista foi alcançada. (URL obrigatória) [documentation_achievements]
    Uma conquista é qualquer conjunto de critérios externos que o projeto trabalhou especificamente para atender, incluindo alguns selos. Esta informação não precisa estar na página inicial do site do projeto. Um projeto usando o GitHub pode colocar conquistas na página inicial do repositório adicionando-as ao arquivo README.

    All of the project's achievements are displayed with hyperlinks at the top of the repository front page (the README), immediately under the title: License (Apache-2.0), CI status, PyPI version, supported Python versions, the OpenSSF Best Practices badge (project 13534, rendered live from bestpractices.dev and linking back to the project's badge page), and the OpenSSF Scorecard badge. Because the Best Practices badge is embedded live from bestpractices.dev, its displayed level updates automatically the moment the achievement is recognized — well within 48 hours — and it already links to the project page. New achievements are added to the same badge row as they are earned.
    https://github.com/Assault-Consulting/Palimpsests


  • Acessibilidade e internacionalização


    O projeto (tanto os sites do projeto quanto os resultados do projeto) DEVERIA seguir as melhores práticas de acessibilidade para que pessoas com deficiências ainda possam participar do projeto e usar os resultados do projeto quando for razoável fazê-lo. [accessibility_best_practices]
    Para aplicações web, veja as Diretrizes de Acessibilidade para Conteúdo Web (WCAG 2.0) e seu documento de apoio Understanding WCAG 2.0; veja também informações de acessibilidade do W3C. Para aplicações GUI, considere usar as diretrizes de acessibilidade específicas do ambiente (como Gnome, KDE, XFCE, Android, iOS, Mac e Windows). Algumas aplicações TUI (por exemplo, programas `ncurses`) podem fazer certas coisas para se tornarem mais acessíveis (como a configuração `force-arrow-cursor` do `alpine`). A maioria das aplicações de linha de comando são bastante acessíveis como estão. Este critério é frequentemente N/A, por exemplo, para bibliotecas de programas. Aqui estão alguns exemplos de ações a tomar ou questões a considerar:
    • Forneça alternativas de texto para qualquer conteúdo não textual para que possa ser transformado em outras formas que as pessoas precisam, como letras grandes, braille, fala, símbolos ou linguagem mais simples (diretriz WCAG 2.0 1.1)
    • A cor não é usada como o único meio visual de transmitir informações, indicar uma ação, solicitar uma resposta ou distinguir um elemento visual. (diretriz WCAG 2.0 1.4.1)
    • A apresentação visual de texto e imagens de texto tem uma razão de contraste de pelo menos 4.5:1, exceto para texto grande, texto incidental e logotipos (diretriz WCAG 2.0 1.4.3)
    • Torne toda a funcionalidade disponível a partir de um teclado (diretriz WCAG 2.1)
    • Um projeto GUI ou baseado na web DEVERIA testar com pelo menos um leitor de tela nas plataformas de destino (por exemplo, NVDA, Jaws ou WindowEyes no Windows; VoiceOver no Mac & iOS; Orca no Linux/BSD; TalkBack no Android). Programas TUI PODEM trabalhar para reduzir o redesenho para evitar leitura redundante por leitores de tela.

    The project's outputs and implementation sites are text-based, which places them at the accessible end of the spectrum by construction, and the documentation follows accessibility best practices where they apply: The software is a command-line tool and a Python library. Its interface is plain text: terminal output works with screen readers and other assistive technology without modification, there is no custom GUI that could introduce visual or interaction barriers, and nothing depends on colour alone to convey meaning. Documentation is Markdown, rendered accessibly by GitHub with proper heading structure, and it handles images correctly for assistive technology — the decorative project icon carries empty alt text so screen readers skip it, while the status badges carry descriptive alt text (License, CI, PyPI, Python versions, OpenSSF Best Practices, Scorecard) so their meaning is announced. The project's development happens on GitHub, whose issue tracker, pull-request, and review interfaces already meet recognized accessibility standards, so contributors using assistive technology can participate in the workflow. Given a text-only CLI and library with plain-text documentation, there is no reasonable additional accessibility work outstanding; the criterion is met within the scope that applies to this kind of project.



    O software produzido pelo projeto DEVERIA ser internacionalizado para permitir fácil localização para a cultura, região ou idioma do público-alvo. Se a internacionalização (i18n) não se aplicar (por exemplo, o software não gera texto destinado a usuários finais e não classifica texto legível por humanos), selecione "não aplicável" (N/A). [internationalization]
    Localização "refere-se à adaptação de um produto, aplicação ou conteúdo de documento para atender aos requisitos de idioma, cultura e outros de um mercado-alvo específico (um locale)". Internacionalização é o "projeto e desenvolvimento de um produto, aplicação ou conteúdo de documento que permite fácil localização para públicos-alvo que variam em cultura, região ou idioma". (Veja "Localization vs. Internationalization" do W3C.) O software atende a este critério simplesmente sendo internacionalizado. Nenhuma localização para outro idioma específico é necessária, pois uma vez que o software foi internacionalizado, é possível para outros trabalharem na localização.

    Internationalization does not meaningfully apply to this project. Palimpsests is a command-line tool and a developer library; its only user-facing text is short diagnostic and status output aimed at developers and operators (e.g. verification results, engine-level messages), not end-user prose or content presented to a general audience. It generates no localizable UI, does no locale-sensitive sorting of human-readable text, and its inputs and outputs are model prompts and structured/binary data (the audit records are a binary wire format with integer fields, deliberately locale-independent by design). There is therefore no target-audience culture, region, or language to localize for. Given a text-only developer CLI/library with no end-user-facing content, i18n is not applicable.


  • Outro


    Se os sites do projeto (site, repositório e URLs de download) armazenam senhas para autenticação de usuários externos, as senhas DEVEM ser armazenadas como hashes iterados com um salt por usuário usando um algoritmo de extensão de chave (iterado) (por exemplo, Argon2id, Bcrypt, Scrypt ou PBKDF2). Se os sites do projeto não armazenam senhas para este propósito, selecione "não aplicável" (N/A). [sites_password_security]
    Observe que o uso do GitHub atende a este critério. Este critério aplica-se apenas a senhas usadas para autenticação de usuários externos nos sites do projeto (também conhecida como autenticação de entrada). Se os sites do projeto precisam fazer login em outros sites (também conhecida como autenticação de saída), eles podem precisar armazenar tokens de autorização para esse propósito de forma diferente (já que armazenar um hash seria inútil). Isso aplica o critério crypto_password_storage aos sites do projeto, semelhante a sites_https.

    The project's sites do not store authentication passwords for external users, so this criterion does not apply. The repository is hosted on GitHub and the project website (palimpsests.dev) is a static site; neither runs a project-operated authentication system or user-account database. Access and identity are handled by the underlying platforms (GitHub authentication, and OIDC/Trusted Publishing for releases), not by password storage the project controls. There are no external-user passwords held on any project site to hash.


 Controle de Mudanças 1/1

  • Versões anteriores


    O projeto DEVE manter as versões mais antigas do produto mais frequentemente usadas ou fornecer um caminho de atualização para versões mais recentes. Se o caminho de atualização for difícil, o projeto DEVE documentar como realizar a atualização (por exemplo, as interfaces que mudaram e etapas sugeridas detalhadas para ajudar na atualização). [maintenance_or_update]

    The project provides a clear upgrade path to newer versions rather than backporting to old ones, which is the appropriate model for a pre-1.0 project. SECURITY.md states the version policy explicitly: Palimpsests is pre-1.0 and evolving, security fixes land on main and in the latest published release, older 0.x releases are not maintained, and users should track the latest version. The upgrade path itself is simple — the package is installed and updated through pip in the standard way — and the changes that affect an upgrade are documented per release in CHANGELOG.md, which follows a Keep-a-Changelog structure with explicit Changed and Breaking sections and upgrade notes where behaviour shifts (for example, the changelog records that before v1.0 minor versions may include breaking changes, and calls out cases such as a first post-upgrade write being required before verify() reports fully). So where an upgrade is non-trivial, the interfaces that changed and the recommended steps are documented.


 Relatórios 3/3

  • Processo de relato de bugs


    O projeto DEVE usar um rastreador de questões para rastrear questões individuais. [report_tracker]

    The project uses GitHub Issues as its issue-tracking system to track individual bugs, tasks, and enhancement requests. CONTRIBUTING.md directs contributors to open or link an issue when submitting work, and security-sensitive reports are routed separately through the private channel described in SECURITY.md. URL: https://github.com/Assault-Consulting/Palimpsests/issues


  • Processo de relato de vulnerabilidades


    O projeto DEVE dar crédito ao(s) relator(es) de todos os relatórios de vulnerabilidade resolvidos nos últimos 12 meses, exceto para o(s) relator(es) que solicitarem anonimato. Se não houve vulnerabilidades resolvidas nos últimos 12 meses, selecione "não aplicável" (N/A). (URL obrigatória) [vulnerability_report_credit]

    No externally reported vulnerabilities have been fixed in the last 12 months, so there is no reporter to credit — which makes this criterion not applicable for the current period. The project is nonetheless set up to credit reporters when the situation arises: SECURITY.md commits to crediting reporters in the release notes unless they ask to remain anonymous. When the first such report is fixed, the reporter will be credited there.



    O projeto DEVE ter um processo documentado para responder a relatos de vulnerabilidades. (URL obrigatória) [vulnerability_response_process]
    Isso está fortemente relacionado a vulnerability_report_process, que exige que haja uma forma documentada de relatar vulnerabilidades. Também está relacionado a vulnerability_report_response, que exige resposta a relatos de vulnerabilidades dentro de um determinado prazo.

    The project has a documented process for responding to vulnerability reports, published in SECURITY.md. It sets out how to report privately (GitHub private security advisories and a maintainer email, not a public issue), a response commitment (the maintainers will acknowledge a report within a few business days and agree on a disclosure timeline before any public disclosure), how reporters are credited (in the release notes, unless anonymity is requested), and which versions receive fixes (security fixes land on main and in the latest release; older 0.x releases are not maintained). This gives a reporter a clear, end-to-end path from private report to coordinated disclosure.
    https://github.com/Assault-Consulting/Palimpsests/blob/main/SECURITY.md


 Qualidade 19/19

  • Padrões de codificação


    O projeto DEVE identificar os guias de estilo de codificação específicos para as linguagens primárias que utiliza, e exigir que as contribuições geralmente estejam em conformidade com eles. (URL obrigatória) [coding_standards]
    Na maioria dos casos, isso é feito referenciando algum(ns) guia(s) de estilo existente(s), possivelmente listando diferenças. Esses guias de estilo podem incluir maneiras de melhorar a legibilidade e maneiras de reduzir a probabilidade de defeitos (incluindo vulnerabilidades). Muitas linguagens de programação têm um ou mais guias de estilo amplamente utilizados. Exemplos de guias de estilo incluem guias de estilo do Google e Padrões de Codificação SEI CERT.

    The project identifies a specific coding style standard for its main language (Python) and requires contributions to comply with it. CONTRIBUTING.md has a "Code style" section naming the standard: ruff with the rule set ["E", "F", "I", "B", "UP"] (pycodestyle/PEP 8, Pyflakes, isort import ordering, flake8-bugbear, pyupgrade), a line length of 100, and target Python 3.11 — with the instruction to run ruff check . before pushing. This is not just documented but enforced: the ruleset is pinned in pyproject.toml ([tool.ruff] / [tool.ruff.lint]), and lint is a merge-blocking status check on main, so every contribution must generally conform before it can be merged.
    https://github.com/Assault-Consulting/Palimpsests/blob/main/CONTRIBUTING.md



    O projeto DEVE aplicar automaticamente seu(s) estilo(s) de codificação selecionado(s) se houver pelo menos uma ferramenta FLOSS que possa fazer isso na(s) linguagem(ns) selecionada(s). [coding_standards_enforced]
    Isso PODE ser implementado usando ferramenta(s) de análise estática e/ou forçando o código através de reformatadores de código. Em muitos casos, a configuração da ferramenta está incluída no repositório do projeto (já que projetos diferentes podem escolher configurações diferentes). Os projetos PODEM permitir exceções de estilo (e normalmente permitirão); onde ocorrem exceções, elas DEVEM ser raras e documentadas no código em suas localizações, para que essas exceções possam ser revisadas e para que as ferramentas possam tratá-las automaticamente no futuro. Exemplos de tais ferramentas incluem ESLint (JavaScript), Rubocop (Ruby) e devtools check (R).

    The project automatically enforces its chosen coding style. The style is defined as ruff with the rule set ["E", "F", "I", "B", "UP"], line length 100, target Python 3.11 (pyproject.toml, [tool.ruff] / [tool.ruff.lint]). ruff is an open-source style/lint tool for Python, and it is run automatically as a merge-blocking status check in CI on every push and pull request — a change that does not conform to the ruleset cannot be merged into main. Contributors also run ruff check . locally before pushing, per CONTRIBUTING.md. So enforcement is automated by an open-source tool for the project's main language, not left to manual review.


  • Sistema de compilação funcional


    Os sistemas de compilação para binários nativos DEVEM honrar as variáveis de compilador e vinculador (ambiente) relevantes passadas para eles (por exemplo, CC, CFLAGS, CXX, CXXFLAGS e LDFLAGS) e passá-las para invocações de compilador e vinculador. Um sistema de compilação PODE estendê-las com flags adicionais; ele NÃO DEVE simplesmente substituir valores fornecidos pelos seus próprios. Se nenhum binário nativo estiver sendo gerado, selecione "não aplicável" (N/A). [build_standard_variables]
    Deve ser fácil habilitar recursos especiais de compilação como Address Sanitizer (ASAN), ou cumprir as melhores práticas de proteção de distribuição (por exemplo, ativando facilmente flags de compilador para fazê-lo).

    The project does not build native binaries, so compiler/linker environment variables (CC, CFLAGS, CXX, CXXFLAGS, LDFLAGS) do not apply. Palimpsests is pure Python, packaged with a PEP 517 build backend (hatchling); the build produces platform-independent wheels and an sdist, with no compilation step of its own. The one native component it can use — the llama.cpp C library — is not compiled by this project; it is consumed at runtime through the optional [native] extra as a separately built dependency. There is therefore no compiler or linker invocation in the project's build for these variables to be honored by.



    O sistema de compilação e instalação DEVERIA preservar informações de depuração se elas forem solicitadas nas flags relevantes (por exemplo, "install -s" não é usado). Se não houver sistema de compilação ou instalação (por exemplo, bibliotecas JavaScript típicas), selecione "não aplicável" (N/A). [build_preserve_debug]
    Por exemplo, definir CFLAGS (C) ou CXXFLAGS (C++) deve criar as informações de depuração relevantes se essas linguagens forem usadas, e elas não devem ser removidas durante a instalação. Informações de depuração são necessárias para suporte e análise, e também úteis para medir a presença de recursos de proteção nos binários compilados.

    There is no compilation or install step in this project that could strip debug information. Palimpsests is pure Python, built with a PEP 517 backend (hatchling) into platform-independent wheels — there are no compiled artifacts and no install -s-style stripping to avoid. Python source is shipped as-is and remains fully inspectable/debuggable; nothing in the build or install removes debug information. (The one native component, llama.cpp, is a separately built runtime dependency behind the optional [native] extra, not something this project's build or install produces.) This criterion therefore does not apply.



    O sistema de compilação do software produzido pelo projeto NÃO DEVE compilar recursivamente subdiretórios se houver dependências cruzadas nos subdiretórios. Se não houver sistema de compilação ou instalação (por exemplo, bibliotecas JavaScript típicas), selecione "não aplicável" (N/A). [build_non_recursive]
    As informações de dependência interna do sistema de compilação do projeto precisam ser precisas, caso contrário, mudanças no projeto podem não compilar corretamente. Compilações incorretas podem levar a defeitos (incluindo vulnerabilidades). Um erro comum em sistemas de compilação grandes é usar uma "compilação recursiva" ou "make recursivo", isto é, uma hierarquia de subdiretórios contendo arquivos fonte, onde cada subdiretório é compilado independentemente. A menos que cada subdiretório seja totalmente independente, isso é um erro, porque as informações de dependência estão incorretas.

    This criterion concerns recursive Make-style builds over subdirectories that have cross-dependencies (the classic "recursive make considered harmful" problem). It does not apply here: Palimpsests is pure Python with a PEP 517 build backend (hatchling), which builds the package as a single unit into wheels and an sdist — there is no recursive per-subdirectory build and therefore no opportunity for a recursive build to mishandle cross-directory dependencies. There is no Makefile or equivalent recursive build system in the project.



    O projeto DEVE ser capaz de repetir o processo de geração de informações a partir de arquivos fonte e obter exatamente o mesmo resultado bit a bit. Se nenhuma compilação ocorrer (por exemplo, linguagens de script onde o código fonte é usado diretamente em vez de ser compilado), selecione "não aplicável" (N/A). [build_repeatable]
    Usuários de GCC e clang podem achar útil a opção -frandom-seed; em alguns casos, isso pode ser resolvido forçando algum tipo de ordenação. Mais sugestões podem ser encontradas no site reproducible build.

    Palimpsests is a pure-Python project: the source is used directly rather than compiled into a different form. There is no compilation step whose output would need to be reproduced bit-for-bit — the .py files that run are the same source files kept in the repository, and packaging (a PEP 517 wheel/sdist via hatchling) simply archives that same source with metadata, it does not transform it. The criterion's own escape clause applies here — "scripting languages where source is used directly rather than compiled" — so this is not applicable.


  • Sistema de instalação


    O projeto DEVE fornecer uma maneira de instalar e desinstalar facilmente o software produzido pelo projeto usando uma convenção comumente utilizada. [installation_common]
    Exemplos incluem usar um gerenciador de pacotes (no nível do sistema ou da linguagem), "make install/uninstall" (suportando DESTDIR), um contêiner em formato padrão, ou uma imagem de máquina virtual em formato padrão. O processo de instalação e desinstalação (por exemplo, seu empacotamento) PODE ser implementado por terceiros, desde que seja FLOSS.

    Installation and removal use the standard, conventional mechanism for Python: pip. The software is published on PyPI and installed with pip install palimpsests (with optional extras — e.g. [native] — enabling the higher execution levels). It is a PEP 517/518 package built with hatchling, so it installs cleanly into any environment via the normal Python packaging path, and it is removed just as conventionally with pip uninstall palimpsests. No custom installer, build-from-source step, or manual file placement is required — the common practice for the language is exactly what the project uses.
    https://pypi.org/project/palimpsests/



    O sistema de instalação para usuários finais DEVE honrar convenções padrão para selecionar o local onde os artefatos compilados são escritos no momento da instalação. Por exemplo, se instalar arquivos em um sistema POSIX, ele DEVE honrar a variável de ambiente DESTDIR. Se não houver sistema de instalação ou convenção padrão, selecione "não aplicável" (N/A). [installation_standard_variables]

    The project has no custom end-user installation system that writes compiled files to system locations, so conventions like DESTDIR do not apply. Installation is handled entirely by pip installing a PEP 517 wheel — pip already places files according to the active Python environment's standard scheme (site-packages / the environment prefix, honoring virtualenv/--prefix/--target as pip defines them), and the project neither overrides that placement nor ships a Makefile-style install target that would need to honor DESTDIR. There are also no compiled files of the project's own to place (pure Python). The criterion's escape clause — no separate install system of the project's own — therefore applies.



    O projeto DEVE fornecer uma maneira para desenvolvedores em potencial instalarem rapidamente todos os resultados do projeto e ambiente de suporte necessário para fazer alterações, incluindo os testes e ambiente de teste. Isso DEVE ser realizado com uma convenção comumente utilizada. [installation_development_quick]
    Isso PODE ser implementado usando um contêiner gerado e/ou script(s) de instalação. Dependências externas normalmente seriam instaladas invocando gerenciador(es) de pacotes do sistema e/ou da linguagem, conforme external_dependencies.

    The project lets a potential developer set up the full change-making environment quickly, using common Python practice. CONTRIBUTING.md gives the steps: clone the repository, then python -m pip install -e ".[dev]" — an editable install of the project plus the [dev] extra, which pulls in the developer and test tooling (ruff pinned, pytest, pytest-httpx, numpy). After that, ruff check . runs the linter and python -m pytest runs the full test suite. So one standard editable-install command brings in the software, the supporting tools, and the test environment together, and tests are run with the standard Python invocation — no bespoke bootstrap script or manual dependency wrangling.


  • Componentes mantidos externamente


    O projeto DEVE listar dependências externas de uma forma processável por computador. (URL obrigatória) [external_dependencies]
    Tipicamente isso é feito usando as convenções do gerenciador de pacotes e/ou sistema de compilação. Note que isso ajuda a implementar installation_development_quick.

    External dependencies are declared in a computer-processable format in pyproject.toml — the standard machine-readable manifest for a PEP 621 Python project. Runtime dependencies are listed under [project.dependencies], and the optional feature sets (e.g. [native] for the level-3 backend, [dev] for the developer/test tooling) under [project.optional-dependencies], each with version constraints (lower bounds; the lint tool pinned). Any standard tool — pip, build back-ends, dependency scanners, Dependabot — parses this file directly, and Dependabot is enabled on the repository to monitor those dependencies.
    https://github.com/Assault-Consulting/Palimpsests/blob/main/pyproject.toml



    Os projetos DEVEM monitorar ou verificar periodicamente suas dependências externas (incluindo cópias de conveniência) para detectar vulnerabilidades conhecidas, e corrigir vulnerabilidades exploráveis ou verificá-las como não exploráveis. [dependency_monitoring]
    Isso pode ser feito usando uma ferramenta de análise de origem / ferramenta de verificação de dependências / ferramenta de análise de composição de software como OWASP's Dependency-Check, Sonatype's Nexus Auditor, Synopsys' Black Duck Software Composition Analysis e Bundler-audit (para Ruby). Alguns gerenciadores de pacotes incluem mecanismos para fazer isso. É aceitável se a vulnerabilidade dos componentes não puder ser explorada, mas esta análise é difícil e às vezes é mais fácil simplesmente atualizar ou corrigir a parte.

    The project monitors its external dependencies for known vulnerabilities on an ongoing basis. Dependabot is enabled on the repository, which continuously watches the dependencies declared in pyproject.toml against vulnerability databases and opens alerts/update pull requests when a known-vulnerable dependency is identified. The project also runs OpenSSF Scorecard, whose checks include dependency-update and vulnerability signals (badge shown on the repository front page). When an alert surfaces, it is handled through the normal pull-request process — updating the dependency, or confirming non-exploitability — under the response practice documented in SECURITY.md. There are currently no known unaddressed vulnerable dependencies.



    "O projeto DEVE:
    1. facilitar a identificação e atualização de componentes mantidos externamente reutilizados; ou
    2. usar os componentes padrão fornecidos pelo sistema ou linguagem de programação.
    Então, se uma vulnerabilidade for encontrada em um componente reutilizado, será fácil atualizar esse componente." [updateable_reused_components]
    Uma maneira típica de atender a este critério é usar sistemas de gerenciamento de pacotes do sistema e da linguagem de programação. Muitos programas FLOSS são distribuídos com "bibliotecas de conveniência" que são cópias locais de bibliotecas padrão (possivelmente bifurcadas). Por si só, isso é bom. No entanto, se o programa *deve* usar essas cópias locais (bifurcadas), então atualizar as bibliotecas "padrão" como uma atualização de segurança deixará essas cópias adicionais ainda vulneráveis. Isso é especialmente um problema para sistemas baseados em nuvem; se o provedor de nuvem atualizar suas bibliotecas "padrão", mas o programa não as usar, então as atualizações na verdade não ajudam. Veja, por exemplo, "Chromium: Why it isn't in Fedora yet as a proper package" by Tom Callaway.

    Reused external components are easy to identify and update. The project does not vendor or copy third-party code into the tree; every externally maintained component is a normal, versioned dependency declared in pyproject.toml ([project.dependencies] and the optional-dependency groups), resolved from PyPI. Because they are standard packaged dependencies rather than embedded copies, updating one when a vulnerability is found is a routine version bump — pip resolves it, Dependabot proposes the update automatically, and no in-tree fork has to be patched by hand. The project also favors standard, widely used components delivered by the platform (e.g. SQLCipher/keyring for at-rest encryption and credential storage, httpx for transport) rather than bespoke implementations, so fixes flow from upstream maintenance.



    O projeto DEVERIA evitar usar funções e APIs obsoletas ou desatualizadas onde alternativas FLOSS estejam disponíveis no conjunto de tecnologia que usa (sua "pilha de tecnologia") e para uma supermaioria dos usuários que o projeto suporta (para que os usuários tenham acesso pronto à alternativa). [interfaces_current]

    The project avoids deprecated or obsolete functions and APIs where supported open-source alternatives exist. It targets current, actively supported Python (3.11+), and modern-Python usage is enforced automatically: the ruff ruleset includes UP (pyupgrade), which flags legacy idioms and pushes code to current language constructs, and lint is a merge-blocking gate — so deprecated patterns do not accumulate. Dependencies are kept current through Dependabot rather than pinned to end-of-life versions, and the components chosen are current, maintained ones (httpx for HTTP, SQLCipher/keyring, hatchling/PEP 517 packaging, Sigstore for signing) rather than deprecated predecessors. There are no known uses of obsolete APIs for which a readily available alternative is being ignored.


  • Conjunto de testes automatizados


    Uma suíte de testes automatizada DEVE ser aplicada a cada check-in em um repositório compartilhado para pelo menos um branch. Esta suíte de testes DEVE produzir um relatório sobre sucesso ou falha do teste. [automated_integration_testing]
    Este requisito pode ser visto como um subconjunto de test_continuous_integration, mas focado apenas em testes, sem exigir integração contínua.

    An automated test suite runs on every change to the shared repository. GitHub Actions CI is triggered on push and on pull request against main (.github/workflows/ci.yml) and executes the full pytest suite across a matrix of three operating systems and Python 3.11/3.12. It produces a clear pass/fail report: the run's success or failure is reported back as a required status check on the commit/PR (and gates merge into main), and the CI status is shown as a live badge on the repository front page. So each change gets an automated suite with an explicit success-or-failure result, not a manual or best-effort check.



    O projeto DEVE adicionar testes de regressão a uma suíte de testes automatizada para pelo menos 50% dos bugs corrigidos nos últimos seis meses. [regression_tests_added50]

    Regression tests are added for well over 50% of bugs fixed — it is the project's standing policy, enforced in review. CONTRIBUTING.md mandates that tests ship with every behavioral change, and a bug fix is a behavioral change, so fixes land with a test that exercises the corrected behavior; because the test suite is a merge-blocking gate, a fix without its covering test does not get merged. Recent fixes demonstrate the practice: for example, a defect in the audit-format test vectors (an anchor-completeness inconsistency) was fixed together with regression tests that assert the exact diagnosis — tests/test_pala_codec.py and tests/test_pala_cli.py verify that a lagging anchor is reported as an unanchored tail with the correct lag count — and earlier subsystem fixes (e.g. in the state validator and the native scheduler) each landed with their own tests/ additions. The per-PR history shows the test-with-fix pattern throughout.



    O projeto DEVE ter suíte(s) de teste automatizada(s) FLOSS que forneçam pelo menos 80% de cobertura de instruções se houver pelo menos uma ferramenta FLOSS que possa medir este critério na linguagem selecionada. [test_statement_coverage80]
    Muitas ferramentas FLOSS estão disponíveis para medir cobertura de testes, incluindo gcov/lcov, Blanket.js, Istanbul, JCov e covr (R). Note que atender a este critério não é uma garantia de que a suíte de testes seja completa, em vez disso, falhar em atender a este critério é um forte indicador de uma suíte de testes pobre.

    The project's automated test suite achieves statement coverage above the 80% threshold, measured by a FLOSS tool. Coverage is measured in CI with pytest-cov / coverage.py (both open source), and the CI coverage job is gated: the build fails if statement coverage drops below 80%. Current statement coverage is ~87% across the codebase. The one module that sits low is the hardware-only ctypes backend (llamacpp_backend.py), which requires a real GGUF model and GPU and is validated on hardware per benchmarks/RUNBOOK.md rather than in CI; excluding that hardware-gated path, the pure-software surface is well covered, and the overall figure still clears 80% comfortably.


  • Teste de novas funcionalidades


    O projeto DEVE ter uma política escrita formal de que, à medida que uma nova funcionalidade importante é adicionada, testes para a nova funcionalidade DEVEM ser adicionados a uma suíte de testes automatizada. [test_policy_mandated]

    The project has a formal written policy requiring tests for new significant functionality to be added to the automated test suite. CONTRIBUTING.md states, as a ground rule for contributions, that tests ship with every behavioral change — so adding new functionality obliges adding the tests that cover it, in the same pull request. The policy is not advisory: the automated suite is a merge-blocking status check on main, so a change introducing new functionality without its covering tests cannot be merged. The requirement is documented in writing, applied to every contributor, and enforced automatically.



    O projeto DEVE incluir, em suas instruções documentadas para propostas de mudança, a política de que testes devem ser adicionados para novas funcionalidades importantes. [tests_documented_added]
    Contudo, mesmo uma regra informal é aceitável desde que os testes estejam sendo adicionados na prática.

    The policy of adding tests for new functionality is documented in the contribution guidelines. CONTRIBUTING.md states, under its Tests section, "Every behavioral change ships with tests in the same PR," and additionally requires security-sensitive code to test escape and denial paths explicitly. This places the policy directly in the instructions contributors read before submitting changes. URL: https://github.com/Assault-Consulting/Palimpsests/blob/main/CONTRIBUTING.md


  • Sinalizadores de aviso


    Os projetos DEVEM ser maximamente rigorosos com avisos no software produzido pelo projeto, onde for prático. [warnings_strict]
    Alguns avisos não podem ser efetivamente habilitados em alguns projetos. O que é necessário é evidência de que o projeto está se esforçando para habilitar flags de avisos onde puder, de forma que erros sejam detectados cedo.

    The project enforces a curated, deliberately-chosen strict rule set that is practical for the codebase: ruff with ["E","F","I","B","UP"] — pycodestyle/pyflakes correctness rules, import ordering, flake8-bugbear (which catches likely bugs and unsafe patterns), and pyupgrade. The linter is pinned to a fixed version and enforced as a required, merge-blocking CI check on every push and pull request, so the strictness is applied consistently rather than advisory. The rule set was chosen for signal over noise rather than enabling every available rule, which is the practical maximum for this project. URL: https://github.com/Assault-Consulting/Palimpsests/blob/main/pyproject.toml


 Segurança 13/13

  • Conhecimento de desenvolvimento seguro


    O projeto DEVE implementar princípios de projeto seguro (de "know_secure_design"), quando aplicável. Se o projeto não está produzindo software, selecione "não aplicável" (N/A). [implement_secure_design]
    Por exemplo, os resultados do projeto devem ter padrões à prova de falhas (decisões de acesso devem negar por padrão, e a instalação dos projetos deve ser segura por padrão). Eles também devem ter mediação completa (todo acesso que possa ser limitado deve ser verificado quanto à autoridade e não ser contornável). Note que em alguns casos os princípios entrarão em conflito, caso em que uma escolha deve ser feita (por exemplo, muitos mecanismos podem tornar as coisas mais complexas, contrariando a "economia de mecanismo" / mantenha simples).

    The project implements secure-design principles concretely, not just documents them:
    Fail-safe / secure defaults. TLS verification is on by default and no insecure transport is enabled by default; in the audit format, an unknown time source (time_trust = UNKNOWN) is required to carry a zero timestamp — the design refuses a confident-but-unjustified value rather than guessing.
    Least privilege. The release workflow grants only the scopes it needs (id-token for OIDC publish, contents for the release), and publishing uses short-lived OIDC identity rather than a broad stored token.
    Minimize / separate the attack surface. Header-only chain verification needs no key and touches no bodies, so a verifier sees no sensitive data; the audit codec is stdlib-only; and the one memory-unsafe boundary (the llama.cpp C library) is isolated behind an optional extra rather than in the core.
    Defense in depth. Untrusted persisted state is bounds-checked by a validator and fuzzed; changes must pass branch protection, non-author review, green tests, coverage, SAST, and signed provenance — layered, not a single control.
    Separation of privilege / keys apart from data. Encryption keys live outside the log (addressed by key_id, in an OS keychain or injected), so the data, its keys, config, and logs are separated; the audit path observes safety events rather than controlling them.
    Open design (no security through obscurity). The audit format is fully specified and independently verifiable — its guarantees rely on the published mechanism, not on secrecy, to the point that a third party can verify a log with their own tool.
    SECURITY.md maps vulnerability classes to these implemented mitigations, and docs/THREAT_MODEL.md and docs/ASSURANCE-CASE.md carry the design reasoning.


  • Usar práticas criptográficas boas e básicas

    Observe que alguns softwares não precisam usar mecanismos criptográficos. Se o seu projeto produzir software que (1) inclui, ativa ou habilita funcionalidade de criptografia, e (2) pode ser liberado dos Estados Unidos (EUA) para fora dos EUA ou para um não cidadão dos EUA, você pode ser legalmente obrigado a tomar algumas etapas extras. Normalmente isso envolve apenas o envio de um e-mail. Para mais informações, consulte a seção de criptografia de Understanding Open Source Technology & US Export Controls.

    Os mecanismos de segurança padrão dentro do software produzido pelo projeto NÃO DEVEM depender de algoritmos criptográficos ou modos com fraquezas sérias conhecidas (por exemplo, o algoritmo de hash criptográfico SHA-1 ou o modo CBC em SSH). [crypto_weaknesses]
    Preocupações sobre o modo CBC em SSH são discutidas em CERT: SSH CBC vulnerability.

    The project's default security mechanisms do not depend on any cryptographic algorithm or mode with known serious weaknesses. It does not use SHA-1 for security purposes, and it does not use SSH or the SSH CBC mode. At-rest encryption uses SQLCipher (AES-256 with HMAC-SHA-256/512, not SHA-1), and transport security uses the platform TLS stack with modern negotiated algorithms. No SHA-1-based or otherwise seriously-weakened primitive is relied upon. URL: https://github.com/Assault-Consulting/Palimpsests/blob/main/SECURITY.md



    O projeto DEVERIA suportar múltiplos algoritmos criptográficos, para que os usuários possam mudar rapidamente se um for quebrado. Algoritmos de chave simétrica comuns incluem AES, Twofish e Serpent. Alternativas comuns de algoritmos de hash criptográfico incluem SHA-2 (incluindo SHA-224, SHA-256, SHA-384 E SHA-512) e SHA-3. [crypto_algorithm_agility]

    The project uses multiple, current cryptographic algorithms and provides an appropriate path to switch if one is broken, though the mechanism differs by layer:
    Transport crypto is delegated to TLS via httpx, which supports multiple algorithms and cipher suites and negotiates them — so algorithm agility there is inherent and does not depend on the project.
    The tamper-evident audit format (PALA-1) deliberately fixes a single strong algorithm per purpose — AES-256-GCM for record bodies, SHA-256 for the hash chain and Merkle tree — because byte-exact agreement between independent verifier implementations is the format's core property, and runtime algorithm negotiation would break reproducibility and open downgrade attacks. Agility is instead handled at the format-version level: the wire header carries format_version, a frozen-field forward-compatibility discipline (§7.6) lets a future version specify a different algorithm while older verifiers still process records they do not fully interpret, so migrating off a broken primitive is a defined, non-disruptive path rather than a rewrite. All algorithms in use are current (SHA-2 family, AES-256), with no broken ones.



    O projeto DEVE suportar o armazenamento de credenciais de autenticação (como senhas e tokens dinâmicos) e chaves criptográficas privadas em arquivos que são separados de outras informações (como arquivos de configuração, bancos de dados e logs), e permitir que os usuários as atualizem e substituam sem recompilação de código. Se o projeto nunca processar credenciais de autenticação e chaves criptográficas privadas, selecione "não aplicável" (N/A). [crypto_credential_agility]

    Authentication credentials and private cryptographic keys are kept separate from other information and are replaceable without recompiling.
    Audit-log encryption keys are not stored inside the project's own files. They are addressed by key_id and held outside the log — in an OS keychain or supplied by explicit injection — so keys live apart from the data, config, and logs they protect. Rotating or replacing a key is a runtime operation (the format even records key destruction as a KEY_SHRED record), never a code change or recompile; and because it is a pure-Python project there is no compilation step to redo regardless.
    Release/publishing identity uses GitHub Trusted Publishing (OIDC), so there is no long-lived private token stored in the repository at all — the credential is short-lived and issued at publish time, not embedded in code or config.
    At-rest secrets (where the desktop/persistence path applies) go through SQLCipher/keyring, which hold them in their own dedicated stores, separate from application data.
    No credential or private key is embedded in source, config files, databases, or logs; each can be updated or replaced independently of the code.



    O software produzido pelo projeto DEVERIA suportar protocolos seguros para todas as suas comunicações de rede, como SSHv2 ou posterior, TLS1.2 ou posterior (HTTPS), IPsec, SFTP e SNMPv3. Protocolos inseguros como FTP, HTTP, telnet, SSLv3 ou anterior, e SSHv1 DEVERIAM estar desabilitados por padrão, e apenas habilitados se o usuário configurá-lo especificamente. Se o software produzido pelo projeto não suportar comunicações de rede, selecione "não aplicável" (N/A). [crypto_used_network]

    Where the software makes network communication, it uses secure protocols only. Outbound network access (e.g. talking to model/back-end endpoints and to release/publishing infrastructure) goes through httpx over HTTPS/TLS — TLS 1.2+ as negotiated by the platform's TLS stack — and release publishing uses HTTPS with OIDC Trusted Publishing and Sigstore. The project does not implement or default to any insecure protocol (no plain HTTP fetch-and-trust, no FTP/telnet/SSLv3/SSHv1); an insecure transport is not enabled anywhere by default. The core product is a local-first, on-device inference engine, so most operation involves no network at all, and what network communication exists is over TLS.



    O software produzido pelo projeto DEVERIA, se suportar ou usar TLS, suportar pelo menos a versão TLS 1.2. Observe que o predecessor do TLS era chamado SSL. Se o software não usar TLS, selecione "não aplicável" (N/A). [crypto_tls12]

    The software uses TLS and supports TLS 1.2 or later. All HTTPS communication goes through httpx, which uses Python's standard TLS stack (OpenSSL via the ssl module); on the supported Python versions (3.11+) that stack negotiates TLS 1.2 and 1.3 and treats older SSL/TLS versions as disabled by default. The project does not force, pin, or fall back to any pre-1.2 protocol (no SSLv3/TLS 1.0/1.1), so TLS 1.2+ is the effective floor for every TLS connection it makes.



    O software produzido pelo projeto DEVE, se suportar TLS, realizar a verificação de certificado TLS por padrão ao usar TLS, incluindo em sub-recursos. Se o software não usar TLS, selecione "não aplicável" (N/A). [crypto_certificate_verification]
    Observe que a verificação incorreta de certificado TLS é um erro comum. Para mais informações, consulte "The Most Dangerous Code in the World: Validating SSL Certificates in Non-Browser Software" por Martin Georgiev et al. e "Do you trust this application?" por Michael Catanzaro.

    Where the software uses TLS, it verifies TLS certificates by default. HTTPS communication goes through httpx, which performs certificate verification (chain and hostname) by default — the project does not disable it (no verify=False, no custom context that turns verification off) and does not weaken it for any request or sub-resource. So certificate validation is on for every TLS connection the software makes, as the library's secure default, and nothing in the project overrides that.



    O software produzido pelo projeto DEVE, se suportar TLS, realizar a verificação de certificado antes de enviar cabeçalhos HTTP com informações privadas (como cookies seguros). Se o software não usar TLS, selecione "não aplicável" (N/A). [crypto_verification_private]

    Where the software uses TLS, certificate validation happens before any request data is sent, so no sensitive HTTP header is transmitted ahead of verification. HTTPS goes through httpx, which completes the TLS handshake — including certificate chain and hostname verification — as part of establishing the connection, before the request line and headers are written; the project keeps this default (no verify=False, no verification deferral or override). In practice the project also does not rely on browser-style secret headers: publishing authentication uses short-lived OIDC tokens over verified HTTPS rather than long-lived secured cookies. Either way, verification precedes the transmission of any header.


  • Lançamento seguro


    O projeto DEVE assinar criptograficamente os lançamentos dos resultados do projeto destinados ao uso generalizado, e DEVE haver um processo documentado explicando aos usuários como eles podem obter as chaves públicas de assinatura e verificar a(s) assinatura(s). A chave privada para essa(s) assinatura(s) NÃO DEVE estar em site(s) usado(s) para distribuir diretamente o software ao público. Se os lançamentos não forem destinados ao uso generalizado, selecione "não aplicável" (N/A). [signed_releases]
    Os resultados do projeto incluem tanto o código-fonte quanto quaisquer entregáveis gerados quando aplicável (por exemplo, executáveis, pacotes e contêineres). Os entregáveis gerados PODEM ser assinados separadamente do código-fonte. Estes PODEM ser implementados como tags git assinadas (usando assinaturas digitais criptográficas). Os projetos PODEM fornecer resultados gerados separadamente de ferramentas como git, mas nesses casos, os resultados separados DEVEM ser assinados separadamente.

    Releases intended for wide use are cryptographically signed, and there is a documented verification process. Distribution artifacts are published to PyPI via Trusted Publishing (OIDC) with Sigstore-backed PEP 740 attestations and signed SLSA Build Level 2 provenance binding the artifact digest to the release workflow, the tag, and the OIDC issuer (.github/workflows/release.yml). How a user obtains the verification material and checks a release is documented in RELEASING.md (referenced from SECURITY.md and the assurance case), and the attestations are also surfaced on the artifact's PyPI "Provenance" section. Crucially, signing is keyless: Sigstore issues short-lived certificates tied to the workflow's OIDC identity and logs them in the Rekor transparency log, and PyPI publishing uses OIDC rather than a stored token — so there is no long-lived private signing key held anywhere, and in particular none on the distribution site. That satisfies the "private key not on the distribution site" requirement by construction.



    É SUGERIDO que no sistema de controle de versão, cada tag de versão importante (uma tag que faz parte de um lançamento principal, lançamento menor ou corrige vulnerabilidades publicamente observadas) seja criptograficamente assinada e verificável conforme descrito em signed_releases. [version_tags_signed]

    The project's release artifacts are cryptographically signed (Sigstore/PEP 740 attestations + SLSA provenance — see signed_releases), but the git version tags themselves are currently lightweight tags, which cannot carry a cryptographic signature. So the specific practice this criterion recommends — signed, verifiable VCS tags — is not yet in place. This is a SUGGESTED criterion, recorded honestly rather than stretched; the artifact-level signing already gives end users a verifiable provenance chain, and adopting signed annotated tags (git tag -s) for future releases is a straightforward improvement we can add.


  • Outras questões de segurança


    Os resultados do projeto DEVEM verificar todas as entradas de fontes potencialmente não confiáveis para garantir que sejam válidas (uma *lista de permissões*), e rejeitar entradas inválidas, se houver quaisquer restrições sobre os dados. [input_validation]
    Observe que comparar a entrada com uma lista de "formatos inválidos" (também conhecida como *lista de negação*) normalmente não é suficiente, porque os atacantes muitas vezes podem contornar uma lista de negação. Em particular, os números são convertidos em formatos internos e então verificados se estão entre o mínimo e o máximo (inclusive), e as strings de texto são verificadas para garantir que sejam padrões de texto válidos (por exemplo, UTF-8 válido, comprimento, sintaxe, etc.). Alguns dados podem precisar ser "qualquer coisa" (por exemplo, um carregador de arquivos), mas estes normalmente seriam raros.

    The project validates input from potentially untrusted sources against an allowlist of what is structurally valid and rejects anything that does not conform.
    Persisted KV-state blobs (the surface reachable through load_state) are checked by a dedicated validator before use: it requires the correct PALKV1 magic and validates the structure, rejecting malformed or unexpected blobs rather than trusting them. This validator is the target of a coverage-guided fuzz harness (Atheris), precisely because it is the untrusted-input boundary.
    The PALA-1 audit wire format is parsed defensively by the codec: every fixed-header field and every TLV is bounds-checked, the container is parsed by frozen-field offsets, and violations (bad lengths, TLV overruns, truncated tails, unexpected values) are reported/rejected rather than accepted. Verification is allowlist-shaped — records are accepted only if they satisfy the specified constraints — and unknown record/TLV types are handled as explicitly-defined "uninterpretable", not silently trusted.
    So untrusted input is validated against known constraints and invalid input is rejected wherever the format imposes constraints.



    Mecanismos de proteção DEVERIAM ser usados no software produzido pelo projeto para que defeitos de software tenham menos probabilidade de resultar em vulnerabilidades de segurança. [hardening]
    Os mecanismos de proteção podem incluir cabeçalhos HTTP como Content Security Policy (CSP), flags de compilador para mitigar ataques (como -fstack-protector), ou flags de compilador para eliminar comportamento indefinido. Para nossos propósitos, o privilégio mínimo não é considerado um mecanismo de proteção (privilégio mínimo é importante, mas separado).

    The software uses hardening mechanisms so that a defect is less likely to become a security vulnerability. The primary mechanism is language choice: all code the project produces is written in a memory-safe language (Python), eliminating whole classes of defect-to-vulnerability paths (buffer overflows, use-after-free). The single memory-unsafe boundary — the third-party llama.cpp C library — is isolated behind an optional [native] extra, and the untrusted-input surface in front of it (the KV-state validator guarding load_state) is coverage-guided fuzzed with Atheris, so malformed input is rejected before any byte reaches C. Additional mechanisms: SQL is parameterized throughout (no injection); there is no unsafe deserialization (pickle/eval/shell=True are absent); cryptographic keys come from a CSPRNG (secrets.token_bytes); the at-rest audit store is encrypted (SQLCipher/AES-256) with the key held in the OS keychain, and the design fails closed — it refuses to open rather than fall back to plaintext if SQLCipher is unavailable; the audit chain's canonical serialization is length-prefixed so field boundaries cannot be forged; provider exception text is clipped before it enters the log to prevent secret leakage; and the CI/release pipeline runs with least-privilege permissions, SHA-pinned actions, and OIDC-scoped publishing. These mechanisms, and the security argument for them, are documented in docs/ASSURANCE-CASE.md, with the asset-to-mechanism mapping in docs/THREAT_MODEL.md. As a local-first library with no network service of its own, HTTP transport-hardening headers do not apply to the software itself; the project website's hardening headers are covered separately under hardened_site.
    https://github.com/Assault-Consulting/Palimpsests/blob/main/docs/ASSURANCE-CASE.md



    O projeto DEVE fornecer um caso de garantia que justifique por que seus requisitos de segurança são atendidos. O caso de garantia DEVE incluir: uma descrição do modelo de ameaças, identificação clara dos limites de confiança, um argumento de que os princípios de projeto seguro foram aplicados e um argumento de que fraquezas comuns de segurança na implementação foram combatidas. (URL obrigatória) [assurance_case]
    Um caso de garantia é "um corpo documentado de evidências que fornece um argumento convincente e válido de que um conjunto específico de reivindicações críticas sobre as propriedades de um sistema são adequadamente justificadas para uma dada aplicação em um dado ambiente" ("Software Assurance Using Structured Assurance Case Models", Thomas Rhodes et al, NIST Interagency Report 7608). Limites de confiança são fronteiras onde os dados ou a execução muda seu nível de confiança, por exemplo, os limites de um servidor em uma aplicação web típica. É comum listar princípios de projeto seguro (como Saltzer e Schroeer) e fraquezas comuns de segurança na implementação (como o OWASP top 10 ou CWE/SANS top 25), e mostrar como cada um é combatido. O caso de garantia do BadgeApp pode ser um exemplo útil. Isso está relacionado a documentation_security, documentation_architecture e implement_secure_design.

    The project provides a structured assurance case in docs/ASSURANCE-CASE.md — a defeasible Claims → Arguments → Evidence argument that Palimpsests provides the security and record-keeping properties it claims. It contains all four required elements:
    Threat model description — the assurance case is built on and cross-references docs/THREAT_MODEL.md, which states the threats and guarantees precisely; the assurance case's Scope and top-level claim (G0 → C1–C5) frame what is defended.
    Clear trust boundaries — the threat model and the per-claim scope define the boundaries (e.g. the audit chain vs. the device owner at the base tier, host-resident at-rest data, the untrusted-input validator surface), and a "Defeaters" section names the conditions under which each claim breaks.
    Argument that secure-design principles are applied — claims C1–C5 argue tamper-evidence, at-rest confidentiality, supply-chain verifiability, declared capabilities, and the engineering-quality substrate, each with its supporting evidence.
    Argument that common implementation vulnerabilities are prevented — C5 (the quality substrate) plus SECURITY.md map vulnerability classes to the implemented mitigations (memory-safe language, validated/fuzzed untrusted input, SAST, no hardcoded secrets), and each claim carries a stated residual so the argument is honest about limits rather than overclaiming.
    https://github.com/Assault-Consulting/Palimpsests/blob/main/docs/ASSURANCE-CASE.md


 Análise 2/2

  • Análise estática de código


    O projeto DEVE usar pelo menos uma ferramenta de análise estática com regras ou abordagens para procurar vulnerabilidades comuns na linguagem ou ambiente analisado, se houver pelo menos uma ferramenta FLOSS que possa implementar este critério na linguagem selecionada. [static_analysis_common_vulnerabilities]
    Ferramentas de análise estática que são especificamente projetadas para procurar vulnerabilidades comuns são mais propensas a encontrá-las. Dito isso, usar quaisquer ferramentas estáticas normalmente ajudará a encontrar alguns problemas, então estamos sugerindo mas não exigindo isso para o nível de selo 'passing'.

    Yes. Bandit — the SAST tool added for the static-analysis criterion — is designed specifically to find common security vulnerabilities in Python. Its rule set targets known vulnerability patterns: hardcoded credentials, injection via unsafe subprocess/shell=True/eval/exec, unsafe deserialization (pickle/yaml), weak or misused cryptographic calls, insecure temp-file handling, and unsafe network/SSL defaults. It runs on the package source on every push and pull request. URL: https://github.com/Assault-Consulting/Palimpsests/blob/main/.github/workflows/sast.yml


  • Análise dinâmica de código


    Se o software produzido pelo projeto incluir software escrito usando uma linguagem insegura em memória (por exemplo, C ou C++), então pelo menos uma ferramenta dinâmica (por exemplo, um fuzzer ou scanner de aplicação web) DEVE ser rotineiramente usada em combinação com um mecanismo para detectar problemas de segurança de memória, como estouros de buffer. Se o projeto não produzir software escrito em uma linguagem insegura em memória, escolha "não aplicável" (N/A). [dynamic_analysis_unsafe]
    Exemplos de mecanismos para detectar problemas de segurança de memória incluem Address Sanitizer (ASAN) (disponível no GCC e LLVM), Memory Sanitizer e valgrind. Outras ferramentas potencialmente usadas incluem thread sanitizer e undefined behavior sanitizer. Assertivas generalizadas também funcionariam.

    The project does not develop software in a memory-unsafe language. Palimpsests is written entirely in Python, a memory-safe language; it works above the attention kernel and contains no C, C++, or other memory-unsafe code of its own. The only native code involved (llama.cpp) is an external, separately-maintained dependency invoked through the [native] extra, not code developed within this project. Per the criterion's own guidance, N/A is selected because the project develops no memory-unsafe software. URL: https://github.com/Assault-Consulting/Palimpsests/blob/main/README.md



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

Entrada de selo do projeto de propriedade de: andreysparish.
Entrada criada em 2026-07-08 10:49:53 UTC, última atualização em 2026-08-23 07:20:40 UTC. Selo de aprovação alcançado pela última vez em 2026-07-08 11:51:23 UTC.