silken_net

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

    Silken Net: a trustless, decentralized D-MRV / Nature-as-a-Service (NaaS) platform for planetary-scale forest-health monitoring. Edge IoT sensors in trees bridge to the Polygon blockchain via a Chainlink oracle, minting Silken Carbon (SCC) and Silken Forest (SFC) tokens from verified biomass-growth telemetry; a Lorenz-attractor homeostasis signal guards against fraud.

    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.

    Honest TRL: backend TRL 8, firmware TRL 6, bio-anchor TRL 3; multi-zone licensing — see NOTICE.

  • 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 "Requirements for acceptable contributions" lists the checks every contribution must pass, per domain: Ruby/Rails — RuboCop, RSpec, Brakeman, bundler-audit; Python — Ruff; firmware — host test suite (make -C firmware/test); Solidity — forge build/test. It also requires matching the surrounding code style and keeping the docs/ single source of truth updated.
    https://github.com/Alexey-Lukin/silken_net/blob/main/CONTRIBUTING.md#requirements-for-acceptable-contributions


  • 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) 1.1 as its contributor-authorization mechanism, documented in CONTRIBUTING.md: by signing off a commit (git commit -s, adding a Signed-off-by trailer) a contributor certifies they wrote the patch or otherwise have the right to submit it under the project's licenses. It complements the inbound=outbound "License of contributions" statement in the same file. (The first DCO-signed commit is already in history.)
    https://github.com/Alexey-Lukin/silken_net/blob/main/CONTRIBUTING.md#developer-certificate-of-origin-dco
    https://developercertificate.org/



    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 is documented in GOVERNANCE.md: Silken Net uses a single-maintainer ("benevolent dictator") model — the founder and sole maintainer (Oleksii Lukin, @Alexey-Lukin) makes all final technical, architectural and release decisions. Day-to-day changes land via the CONTRIBUTING.md pull-request flow with maintainer review (CODEOWNERS); architecture is decided documentation-first in the SSOT docs. This project (development) governance is explicitly distinct from the on-chain SFC DAO that governs the deployed protocol's parameters (docs/05_06).
    https://github.com/Alexey-Lukin/silken_net/blob/main/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 the Contributor Covenant 2.1 as its code of conduct, posted in the standard top-level location CODE_OF_CONDUCT.md (GitHub surfaces it on the repository's Community page and when opening issues/PRs). It defines expected and unacceptable behavior, scope, and a reporting/enforcement process with a contact.
    https://github.com/Alexey-Lukin/silken_net/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.

    The project's key roles and responsibilities are documented in GOVERNANCE.md (the "Roles" section): Maintainer / Lead — Oleksii Lukin (@Alexey-Lukin) — responsible for final decisions, code review, releases and security response; Contributors — anyone — propose changes via pull requests (CONTRIBUTING.md). It is clear who holds the maintainer role. Governance and roles are documented together, as this criterion permits.
    https://github.com/Alexey-Lukin/silken_net/blob/main/GOVERNANCE.md#roles



    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 is fully FLOSS (AGPL-3.0-or-later) with all source, history, issues, pull requests and releases public on GitHub, the docs mirrored to the wiki, and contracts/telemetry on public chains — nothing required to continue the project is held in a private silo. As documented in GOVERNANCE.md ("Continuity"), if the sole maintainer becomes unavailable any contributor can fork the public repository and, within a week, create/close issues, accept proposed changes, and cut releases (release-please + standard GitHub Releases need no private key); the AGPL licence grants the legal rights to do so. Additional maintainers will be added as the project grows.
    https://github.com/Alexey-Lukin/silken_net/blob/main/GOVERNANCE.md#continuity



    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.

    Unmet — the project currently has a single maintainer, so its bus factor is 1. This is mitigated: the project is fully FLOSS with all code, history, issues and releases public on GitHub (forkable by anyone — see GOVERNANCE.md "Continuity"), so loss of the maintainer does not lose the project, only its stewardship. The maintainer intends to add co-maintainers as the contributor base grows, raising the bus factor to 2+.
    https://github.com/Alexey-Lukin/silken_net/blob/main/GOVERNANCE.md#continuity


  • 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 has a documented roadmap in docs/00_01 (Vision, Mission & Roadmap), §4 "High-Level Roadmap", with dated phases — Phase 1 "The First Breath" (2026: R&D + validation), Phase 2 "The Cyber-Physical State" (2027-2028: regional expansion), Phase 3 "Planetary Scale" (2029-2030) — well beyond the next year. What is deliberately out of near-term scope is separated into the far-horizon agenda (docs/00_08, 2030-2040+, explicitly not TRL-gated). Near-term intended work is tracked live in docs/00_07.
    https://github.com/Alexey-Lukin/silken_net/blob/main/docs/00_01_Vision_Mission_and_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 architecture is documented as the 8-level SilkenNet stack (L1 biophysics / Ti-6Al-4V anchor + EBFC → L3 firmware + edge AI → L5 Rails backend → L7 Polygon/DeFi → L8 Ethereum L1 finalization): the high-level diagram and the multichain / tech-stack tables are in the README, the canonical system map and reading order in docs/00_00, and each layer's detailed design has its own module (e.g. docs/02_01 hardware architecture, docs/05_01 multichain). The major components, their relationships and key properties are all covered.
    https://github.com/Alexey-Lukin/silken_net/blob/main/docs/00_00_SSOT_Index.md
    https://github.com/Alexey-Lukin/silken_net#readme



    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's security expectations and limitations are documented. SECURITY.md states the in-scope components and a "Known, documented limitations" section that openly states what users should NOT expect today — e.g. the transitional AES-128-ECB LoRa link (no MAC/IV yet, bench-gated for migration to authenticated AES-128-CCM), with the open security backlog tracked in docs/00_07 (SEC.*). The intended security model the software aims to meet — AES-128-CCM (LoRa) / AES-256-CBC+GCM (CoAP + at-rest), SE050 secure element, per-device HKDF keys, IV/nonce generation, and the PQC migration roadmap — is the canonical SSOT in docs/03_05.
    https://github.com/Alexey-Lukin/silken_net/blob/main/SECURITY.md
    https://github.com/Alexey-Lukin/silken_net/blob/main/docs/03_05_Hardware_Symmetric_Crypto_and_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 README has a "Quick Start" section: clone the repo, bundle install, bin/rails db:prepare, bin/dev (Rails + Sidekiq + Tailwind + CoAP listener), then bin/rails db:seed + bin/forest_simulator to generate live telemetry without any hardware — so a new user can get the system doing something within minutes. CONTRIBUTING.md also links to it.
    https://github.com/Alexey-Lukin/silken_net#readme



    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.

    Documentation currency is a first-class, mechanically-enforced discipline — the project's core "SSOT" methodology (docs/00_06). Beyond "making an effort", the docs.yml CI workflow is the single home for structural doc gates that actively prevent drift: docs:check_refs (dangling cross-refs, deprecated/retired terms, owner-only vocabulary such as the RTC register map and Lorenz constants, ToC sync — 27 drift linters in lib/docs_linter.rb), tracker:check (the action-plan tracker), and a code↔doc registry gate (scripts/model_doc_sync.rb maps app/models and app/services 1:1 to their doc sections). Any documented value that drifts from the code fails CI. The one-home rule (one fact, one canonical doc — 00_06 §2) is the standing principle; known inconsistencies are tracked and fixed in docs/00_07.
    https://github.com/Alexey-Lukin/silken_net/blob/main/docs/00_06_SSOT_Documentation_Standard.md
    https://github.com/Alexey-Lukin/silken_net/blob/main/.github/workflows/docs.yml



    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.

    The repository front page (README) identifies and hyperlinks the project's achievements at the very top: the OpenSSF Best Practices badge (passing — project 13358) and the OpenSSF Scorecard badge, each linking to its source page. The badges are also on the wiki landing page (docs/00_00). They were added and updated as the badge progressed (in_progress → passing), within the 48-hour window.
    https://github.com/Alexey-Lukin/silken_net#readme


  • 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 web frontend (Phlex + Turbo + Tailwind) follows accessibility best practices: visible keyboard focus indicators via Tailwind focus-visible: utilities (used in ~48 components), ARIA semantics (role and aria-live attributes), light/dark theming plus prefers-reduced-motion and prefers-contrast media-query handling in the stylesheet, semantic Phlex components (navigation, pagination, locale switcher, mobile-nav toggle), and a design system that drives all colour through semantic tokens (supporting contrast and theme adaptation). The UI accessibility conventions are documented in docs/04_04 (Phlex UI & Tailwind).
    https://github.com/Alexey-Lukin/silken_net/blob/main/docs/04_04_Phlex_UI_and_Tailwind.md



    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.

    The software is internationalized using Rails i18n: user-facing strings go through I18n.t (148 files) rather than being hardcoded, message catalogues live in config/locales (currently English, Ukrainian, Lithuanian and Latvian), and the UI includes a locale switcher component. Adding a new locale is a matter of dropping in another YAML catalogue — no code changes — exactly what this criterion asks for.
    https://github.com/Alexey-Lukin/silken_net/tree/main/config/locales


  • 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 — the repository, the project home page (the GitHub wiki), and the download/release URLs — are all hosted on GitHub. As this criterion explicitly notes, the use of GitHub meets the requirement: external-user authentication and any password storage for these sites is handled by GitHub, not by the project. (Separately, the software produced by the project stores its own end-user passwords with Argon2id + per-user salt — covered under crypto_password_storage.)
    https://github.com/Alexey-Lukin/silken_net


 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. It uses Semantic Versioning (managed by release-please) and publishes a human-readable CHANGELOG documenting the features and fixes in each release, so users can see exactly what changed when moving between versions. The backend is a continuously-deployed service (users run the latest); the firmware and smart contracts follow the same versioned releases. At this stage (v0.x) upgrades are not breaking-complex, so updating to the newest release is the upgrade path, and any future breaking change will be documented in the CHANGELOG / release notes with the steps needed.
    https://github.com/Alexey-Lukin/silken_net/blob/main/CHANGELOG.md
    https://github.com/Alexey-Lukin/silken_net/releases


 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 tracker for individual issues.
    https://github.com/Alexey-Lukin/silken_net/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]

    N/A — no vulnerability reports have been received or resolved in the last 12 months (zero repository security advisories), so there are no reporters to credit. The credit practice for when a report is resolved is now documented in SECURITY.md ("Credit"): reporters are credited in the advisory and/or release notes unless they request anonymity.
    https://github.com/Alexey-Lukin/silken_net/blob/main/SECURITY.md



    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 process for responding to vulnerability reports is documented in SECURITY.md: reports are received privately via GitHub Security Advisories, acknowledged within 72 hours, with a fix or mitigation for high-severity issues targeted within 14 days; the in-scope components, openly-tracked known limitations, and a safe-harbor statement are also included. The open security backlog is tracked in docs/00_07 (SEC.*).
    https://github.com/Alexey-Lukin/silken_net/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 guide for each primary language, documented in CONTRIBUTING.md ("Coding standards"): Ruby — the Rails Omakase RuboCop style (.rubocop.yml inherits rubocop-rails-omakase); Python — Ruff (ruff.toml, a curated pycodestyle/pyflakes/isort/pyupgrade/bugbear ruleset); firmware C — -Wall -Wextra -Wpedantic + cppcheck (MISRA C:2012 advisory); Solidity — forge fmt; C# — .editorconfig (.NET conventions). Contributions are required to comply (CI must be green).
    https://github.com/Alexey-Lukin/silken_net/blob/main/CONTRIBUTING.md#requirements-for-acceptable-contributions



    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 selected styles are enforced automatically in CI by FLOSS tools, and a contribution that violates them fails the build: RuboCop (Ruby) and Ruff (Python) in the ci.yml lint jobs, cppcheck for firmware C (firmware_lint), and forge fmt / Slither for Solidity (solidity_audit.yml). Tool configs live in the repo (.rubocop.yml, ruff.toml, contracts/foundry.toml, tools/cad/.editorconfig). Exceptions are rare and documented in code at their locations — e.g. inline // cppcheck-suppress with a reason, and fingerprinted, annotated entries in config/brakeman.ignore.
    https://github.com/Alexey-Lukin/silken_net/blob/main/.github/workflows/ci.yml


  • 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 native-binary build (firmware/test/Makefile) honors the compiler/linker variables passed in via the environment or command line: CC ?= gcc (a packager can pass CC=clang) and CFLAGS += <project flags> (env/CLI CFLAGS are honored and the project EXTENDS them with its mandatory -std=c11 -I., never replacing). The recipes are single-invocation gcc compile+link, so linker flags carried in CFLAGS (e.g. -Wl,-z,relro) reach the linker too — making it easy to enable ASAN or distribution-hardening flags. Verified: an env CFLAGS value passes through to the compiler, and CI (firmware_test) is green. (The Rails backend and Solidity contracts produce no native binaries.)
    https://github.com/Alexey-Lukin/silken_net/blob/main/firmware/test/Makefile



    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.

    The build preserves debugging information when requested: passing CFLAGS="-g" is honored by the Makefile (CFLAGS += extends the user's flags) so debug info is generated, and the firmware host tests run in place and are never installed with stripping (there is no "install -s" / strip step). The dedicated coverage (--coverage) and ASAN (-g) lanes also build with debug/instrumentation symbols. (The Rails backend and Solidity contracts have no native-binary build/install that strips symbols.)
    https://github.com/Alexey-Lukin/silken_net/blob/main/firmware/test/Makefile



    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.

    The build systems do not use recursive make over cross-dependent subdirectories. The only native build (firmware/test/Makefile) is a single, non-recursive Makefile: each target lists its full header/source dependencies and the shared firmware/common headers compile directly into each test via -I (no per-subdirectory independent builds). Its only $(MAKE) calls recurse into the same directory (the asan/coverage re-instrumented rebuilds), never into subdirectories, so the dependency information is complete and accurate. The other toolchains (Bundler, Foundry/forge, npm, conda) are not recursive-make either.
    https://github.com/Alexey-Lukin/silken_net/blob/main/firmware/test/Makefile



    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.

    Builds and code-generation are reproducible bit-for-bit, and CI enforces it. Generated firmware artifacts are checked against their source on every run: tools/ml/scripts/check_firmware_tables.py regenerates the log-mel tables and fails if they differ from the committed headers, and tools/firmware/check_bytecode.py verifies the committed lorenz_bytecode.h matches bio_contract.rb; QEMU jobs additionally assert host↔Cortex-M4 bit-parity. Solidity bytecode is deterministic — solc is pinned (solc_version = 0.8.35) with fixed optimizer settings (foundry.toml), so forge build reproduces the same bytecode. (The Rails backend is interpreted Ruby — no compiled artifact.)
    https://github.com/Alexey-Lukin/silken_net/blob/main/.github/workflows/ci.yml


  • 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.

    The software is installed via commonly-used conventions. The backend is packaged as a container in a standard format (Dockerfile, multi-stage build on ruby:4.0.5-slim) and deployed with Kamal (config/deploy.yml: image, registry, servers) — kamal setup / kamal deploy installs it, kamal remove uninstalls it. For development it installs at the language level via Bundler (bundle install) per the README Quick Start, and uninstalling is removing the directory/containers. The smart contracts deploy on-chain via Foundry scripts.
    https://github.com/Alexey-Lukin/silken_net/blob/main/Dockerfile
    https://github.com/Alexey-Lukin/silken_net#readme



    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]

    N/A — the project has no installation system that writes built artifacts to a
    user-selectable location, so the DESTDIR/PREFIX convention does not apply. The
    end-user software (the D-MRV Rails platform) is delivered as a self-contained
    container image (Docker, deployed by Kamal — config/deploy.yml) or run in place
    from its working directory after a Bundler install; neither has a DESTDIR/PREFIX
    step. There is no make install / PREFIX / DESTDIR target anywhere in the repo.
    The one first-party Python package (tools/ml, "silken-ml") is internal ML tooling
    run in place (PYTHONPATH=src) or via an editable pip install -e inside a conda
    env — an editable install links the source tree rather than writing built
    artifacts to a chosen location — so it is not an end-user installation system
    either. (CMSIS-DSP and mruby ship their own packaging but are vendored
    third-party submodules, not this project's installation system.)



    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.

    bin/setup (the standard idempotent Rails dev-bootstrap script — runs
    bundle install, bin/rails db:prepare, clears logs, starts the dev server).
    The README "Quick Start" documents the system-package prerequisites, the same
    steps, and how to run the test suite (bundle exec rspec). The repo is polyglot,
    so each domain installs its support + test environment via its standard language
    package manager, all listed in CONTRIBUTING.md: Bundler for Ruby/Rails (tests:
    rspec); npm ci + Foundry for the Solidity contracts (tests: forge test); a
    conda environment file for the Python in-silico/ML tooling
    (tools/*/environment.yml); and make -C firmware/test for the host-based
    firmware tests (no ARM toolchain needed). A Dockerfile is also provided as the
    generated-container path.
    https://github.com/Alexey-Lukin/silken_net/blob/main/bin/setup
    https://github.com/Alexey-Lukin/silken_net/blob/main/CONTRIBUTING.md
    https://github.com/Alexey-Lukin/silken_net#readme


  • 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.


    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.

    External dependencies are monitored continuously and on every CI run across
    the polyglot stack:

    • Dependabot (.github/dependabot.yml) — weekly, 5 ecosystems: bundler (gems),
      docker (base-image tag+digest), github-actions, npm (contracts/), terraform.
    • bundler-audit (the OpenSSF-listed Ruby SCA tool) runs in CI on every push
      (.github/workflows/ci.yml) against the ruby-advisory-db; brakeman runs SAST.
    • Slither runs SCA / static analysis on the Solidity contracts
      (.github/workflows/solidity_audit.yml).
    • OpenSSF Scorecard runs weekly + on push (.github/workflows/scorecard.yml) and
      publishes results; its Vulnerabilities check queries osv.dev and its
      Dependency-Update-Tool check confirms Dependabot is active.
      The conda-managed Python research tooling and the pinned git-submodule vendored
      C libraries are not on Dependabot, but they are development/in-silico only and
      sit outside the deployed runtime trust boundary (the production service is the
      Rails app + its gems + the Docker base image, all of which are monitored).
      https://github.com/Alexey-Lukin/silken_net/blob/main/.github/dependabot.yml
      https://github.com/Alexey-Lukin/silken_net/blob/main/.github/workflows/scorecard.yml


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

    Met (via both routes — standard package managers and easy-to-update pins; no
    forked convenience copies). Every reused component is identified in a
    computer-processable manifest and updated by a standard mechanism:

    • Gems (Gemfile/lock, bundle update), npm for contracts, conda for the Python
      tooling, .NET PackageReference, and JS via Rails importmap (bin/importmap pin).
    • Vendored C/firmware + CAD libraries are git submodules pinned to the CANONICAL
      UPSTREAM repositories (.gitmodules: ARM-software/CMSIS, mruby/mruby,
      LoupVaillant/Monocypher, STMicroelectronics HAL, leap71) — they are not forks,
      so a security fix is applied by bumping the submodule pin to a new upstream tag.
    • Front-end JS is supplied by the Rails framework gems (turbo/stimulus/activestorage)
      plus one version-explicit CDN pin (leaflet@1.9.4), updateable via bin/importmap.
    • OpenSSL and PostgreSQL are standard system components.
      Dependabot automates update PRs for the package-managed ecosystems weekly, so a
      vulnerable reused component is straightforward to update.
      https://github.com/Alexey-Lukin/silken_net/blob/main/.gitmodules
      https://github.com/Alexey-Lukin/silken_net/blob/main/.github/dependabot.yml


    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]

    Met. The project runs a current technology stack (Ruby 4.0.5, Rails 8.1,
    PostgreSQL 17, Solidity 0.8.35 / EVM cancun, .NET 9) — no EOL or obsolete
    frameworks — and actively flags deprecated/obsolete APIs in CI so the FLOSS-current
    alternative is used:


  • 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.

    Met. A GitHub Actions automated test suite runs on every check-in — triggered on
    push to main and on every pull_request (.github/workflows/ci.yml) — and
    produces a pass/fail report via the Actions checks UI and the ci-ok aggregate
    required check. The suite spans the polyglot stack: RSpec for the Rails backend
    (bundle exec rspec), the firmware host-test suite (make -C firmware/test, plus
    an ASan/UBSan lane), Foundry forge test for the Solidity contracts
    (solidity_audit.yml), and language smoke workflows (ml_smoke, in_silico_smoke,
    cad_smoke, coap_smoke).
    https://github.com/Alexey-Lukin/silken_net/blob/main/.github/workflows/ci.yml
    https://github.com/Alexey-Lukin/silken_net/actions



    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]

    Met. The standing practice is to land a bug fix together with a regression test in
    the same commit/PR. An audit of the bug-fix commits over the last six months shows
    a clear majority shipped with a test change in the same commit; the share is higher
    for the shipped product code (Rails backend, firmware, smart contracts) — e.g.
    "Fix OTA packager 8-bit overflow + implement missing CRC16" (firmware host tests),
    "fix: rollback receipt envelope, OTA HMAC trailer, Celo double-pay" (RSpec),
    "fix(queen): FW.51 — telemetry not lost on CoAP-flush failure" (firmware host
    tests), "Fix double-anchoring risk in EthereumAnchorWorker" (RSpec). Regression
    tests live in the automated suites: RSpec (spec/), firmware host tests
    (firmware/test/), and Foundry (contracts/test/). A class of in-silico
    research-script tuning fixes (simulation NaN/SCF convergence) are not
    unit-regression-testable and are outside the shipped-product bug count.
    https://github.com/Alexey-Lukin/silken_net/tree/main/spec
    https://github.com/Alexey-Lukin/silken_net/blob/main/CONTRIBUTING.md#requirements-for-acceptable-contributions



    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 Ruby/Rails backend — the bulk of the codebase — is measured by SimpleCov
    (FLOSS, with branch coverage enabled), and the full CI suite enforces a hard gate of
    minimum_coverage line: 99, branch: 95 (spec/spec_helper.rb): the build fails below
    99% statement coverage, well above the 80% bar. A per-group tripwire additionally
    floors Services/Workers/Models at ~99% line so no single area can erode while the
    global average holds. The other languages are measured with FLOSS coverage tools too:
    the firmware C host suite via gcov/lcov (make -C firmware/test coverage) and the
    Solidity contracts via forge coverage --report lcov (→ Codecov). The coverage-scope
    policy is documented in docs/04_06 §B.
    https://github.com/Alexey-Lukin/silken_net/blob/main/spec/spec_helper.rb
    https://github.com/Alexey-Lukin/silken_net/blob/main/.github/workflows/ci.yml


  • 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 testing policy in CONTRIBUTING.md
    ("Requirements for acceptable contributions"): "Tests are mandatory for new
    functionality (project policy). When you add or change functionality you MUST add
    or update automated tests; as major new functionality is added, tests for it MUST
    be added to the relevant automated suite (RSpec / Foundry forge / firmware host
    tests). A pull request that adds major new functionality without accompanying
    tests will not be merged." The policy is backed in practice by the project's
    regression-test record (see regression_tests_added50) and the SimpleCov 99%
    line-coverage gate enforced in CI.
    https://github.com/Alexey-Lukin/silken_net/blob/main/CONTRIBUTING.md#requirements-for-acceptable-contributions



    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 add-tests policy is documented in CONTRIBUTING.md under "Requirements for acceptable contributions".
    https://github.com/Alexey-Lukin/silken_net/blob/main/CONTRIBUTING.md#requirements-for-acceptable-contributions


  • 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.

    Met — strict where practical, enforced in CI across every language:

    • Firmware C: compiled with -Wall -Wextra -Wpedantic (-std=c11); cppcheck is a hard
      CI gate (firmware_lint: --enable=warning,performance,portability,style,
      --error-exitcode=1, MISRA C:2012 addon, --check-level=exhaustive), plus an
      ASan/UBSan runtime lane.
    • Ruby: RuboCop (rails-omakase) gates CI and fails on any offense.
    • Python: Ruff's strict rule-set (E/W/F/I/UP/B/C4/SIM/RUF) gates CI, and the test
      suite escalates DeprecationWarning to an error.
    • Solidity: forge fmt --check and Slither static analysis gate CI.
    • Security SAST: Brakeman gates CI.
    • .NET CAD: default .NET analyzers run on the first-party code; strictness is
      relaxed only in the third-party LEAP71 wrapper, where it is not practical.
      https://github.com/Alexey-Lukin/silken_net/blob/main/firmware/test/Makefile
      https://github.com/Alexey-Lukin/silken_net/blob/main/.github/workflows/ci.yml

 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).

    Met. Secure design principles are implemented across the stack:

    • Fail-safe / deny-by-default: minting refuses unless every condition holds —
      BlockchainMintingService raises "Security Breach" unless the telemetry is
      verified_by_iotex?, oracle_status_fulfilled?, and KYC-approved; in production
      WEB3_STRICT_MODE=true turns missing security config (e.g. CHAINLINK_HMAC_SECRET)
      into a hard raise instead of a silent fallback.
    • Secure by default (deployment): production enforces config.force_ssl + HSTS
      (preload, 1-year, subdomains), a Content-Security-Policy with a per-request
      nonce, X-Frame-Options: DENY, X-Content-Type-Options: nosniff, a Permissions-
      Policy, and session cookies set httponly + same_site:lax + secure.
    • Complete mediation: per-resource Pundit policies (app/policies/*) plus role gates
      in the API base controller (authorize_admin!/super_admin!/forester!); thin
      controllers and AASM state machines make state changes non-bypassable.
    • Least privilege / separation of privilege: on-chain roles are split and gated by
      onlyRole(...), admin actions are routed through a Timelock, and mint()/slash()
      run on physically separate keys (MINTER_ROLE vs SLASHER_ROLE).
    • Defense in depth: a manual_review double-spend guard freezes funds when a
      transaction state is unknown; anomaly/tamper telemetry is zeroed for minting in
      BOTH firmware and backend; no weak crypto is used (no MD5/SHA-1/DES/RC4) —
      Argon2id passwords, an HKDF/HMAC key ratchet (NIST SP 800-108), AES + Ed25519.
    • Economy of mechanism: an explicit YAGNI "lazy-senior" ladder + Ruthless Pruning
      keep mechanisms minimal (CLAUDE.md §4), with input validation at trust boundaries.

    https://github.com/Alexey-Lukin/silken_net/blob/main/docs/03_05_Hardware_Symmetric_Crypto_and_Security.md
    https://github.com/Alexey-Lukin/silken_net/blob/main/config/environments/production.rb


  • 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.

    Verified across the whole stack — no algorithms with serious known weaknesses are used. Hashes: SHA-256 / HMAC-SHA256 (keccak256 in contracts); no SHA-1 or MD5 anywhere. Password hashing: Argon2id. Signatures: Ed25519. RNG: SecureRandom (backend) + hardware TRNG (firmware). The CoAP backhaul is AES-256-CBC with a fresh random IV per message (semantic security; not the SSH-CBC weakness); the LoRa target is authenticated AES-128-CCM. The only weak mode is the transitional LoRa AES-128-ECB, whose risk and mitigations are documented in docs/03_05 and which is migrating to AES-128-CCM (FW.2).
    https://github.com/Alexey-Lukin/silken_net/blob/main/docs/03_05_Hardware_Symmetric_Crypto_and_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]

    Met (SHOULD). The project uses multiple cryptographic algorithm families and is
    built to switch primitives rather than hard-wiring one:

    • Hashes: both SHA-2 (SHA-256 — backend integrity, HMAC-SHA256, HKDF, audit-log
      hash chain, firmware) and SHA-3 (keccak256 — Solidity roles/parameter keys and
      Eth::Util.keccak256 on the backend) are in active use.
    • Signatures: two schemes — Ed25519 (SE050 device attestation, peaq DID, M2M auth)
      and secp256k1/ECDSA (EVM chains, IoTeX verification).
    • Symmetric: AES in four selectable modes (ECB, CCM, CBC, GCM). The backend names
      the cipher as an OpenSSL string (OpenSSL::Cipher.new("aes-256-cbc")), so switching
      to any OpenSSL-supported cipher is a one-line change, and the live
      ECB->authenticated-CCM migration is runtime-selectable via the
      TELEMETRY_CCM_ENABLED / FW2_CCM_ENABLED flags — a working demonstration of
      switching a primitive when one is found weak. A documented PQC migration roadmap
      (docs/03_05 §10) plans the post-quantum transition.
      The symmetric cipher is AES (not Twofish/Serpent) because the STM32 nodes are bound
      to the hardware AES engine; agility there is at the mode level plus the documented
      migration roadmap.
      https://github.com/Alexey-Lukin/silken_net/blob/main/docs/03_05_Hardware_Symmetric_Crypto_and_Security.md


    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]

    Met. Credentials and private keys are stored in dedicated files/stores — separate
    from code, in-repo config, the database, and logs — and are replaceable at runtime
    without recompiling (Ruby is interpreted; secrets are read at boot):

    • App secrets (DB password, API/RPC keys, the Chainlink HMAC secret, etc.) live in
      Rails' encrypted credentials (config/credentials.yml.enc) decrypted by a separate
      config/master.key, and/or in environment variables (config/database.yml and code
      read them via ENV.fetch / Rails.application.credentials). master.key and .env* are
      git-ignored; at deploy RAILS_MASTER_KEY and other secrets are injected via Kamal
      secrets (.kamal/secrets) from the environment / a secrets manager, never committed.
    • User passwords are stored only as Argon2id hashes (HasArgon2Password concern,
      OWASP-recommended), never in plaintext.
    • Private cryptographic keys are rotatable without code changes: a key ratchet
      (Cryptography::KeyRatchet), an OTA HMAC-key service, and an over-the-air
      key-rotation worker replace device keys at runtime; the SE050 secure element holds
      non-extractable keys.
    • Secrets are kept out of logs by an explicit filter_parameters allowlist
      (passwords, tokens, *_key, private_key, mnemonic, wallet_private_key, signature…).
      https://github.com/Alexey-Lukin/silken_net/blob/main/.kamal/secrets
      https://github.com/Alexey-Lukin/silken_net/blob/main/config/initializers/filter_parameter_logging.rb


    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]

    Met (SHOULD). All IP/web network communications use TLS by default and no insecure
    protocol is enabled:

    • The web app and API enforce HTTPS in production (config.force_ssl = true) with
      HSTS (1 year, includeSubdomains, preload) and assume_ssl behind the TLS-terminating
      Kamal proxy (Let's Encrypt, TLS 1.2/1.3). HTTP is redirected to HTTPS.
    • All outbound calls use HTTPS — chain RPC (Alchemy/Infura), Chainlink Functions,
      IoTeX and peaq endpoints — with default certificate verification (no VERIFY_NONE).
    • A scan of the code finds no FTP, telnet, SSLv3/earlier, SSHv1, or plain-HTTP
      endpoints.
      For the constrained IoT radio link (Soldier->Queen LoRa, Queen->Rails CoAP) TLS/DTLS
      is not feasible on a tens-of-bytes LoRa frame, so confidentiality and integrity are
      provided at the application layer with AES: AES-128-CCM (authenticated; the
      LoRaWAN/Zigbee/Thread/BLE golden standard for constrained IoT) on the LoRa link and
      AES-256-CBC with a per-message random IV on the CoAP backhaul. This design — and why
      heavier schemes such as Kyber do not fit the radio MTU — is documented in docs/03_05.
      The transitional AES-128-ECB LoRa mode is documented and is migrating to AES-128-CCM.
      https://github.com/Alexey-Lukin/silken_net/blob/main/config/environments/production.rb
      https://github.com/Alexey-Lukin/silken_net/blob/main/docs/03_05_Hardware_Symmetric_Crypto_and_Security.md


    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]

    Met (SHOULD). The project uses TLS and supports TLS 1.2+ everywhere; nothing is
    configured to allow TLS 1.1 or earlier:

    • Inbound HTTPS is terminated by the Kamal proxy with automatic Let's Encrypt
      certificates (config/deploy.yml, proxy ssl: true); the proxy (Go crypto/tls)
      negotiates TLS 1.2/1.3 and does not offer TLS 1.0/1.1. The Rails app enforces it
      with config.force_ssl = true and HSTS (1 year, includeSubdomains, preload) in
      production.rb, so HTTP is redirected to HTTPS.
    • Outbound HTTPS (chain RPC, Chainlink, IoTeX, peaq) is made by Ruby 4.0.5 on
      OpenSSL 3.6.2, which negotiates TLS 1.2/1.3 by default and has TLS 1.0/1.1
      disabled; no client sets a lower ssl_version/min_version.
      No SSLv2/SSLv3 or TLS 1.1-or-earlier is configured or supported anywhere in the stack.
      https://github.com/Alexey-Lukin/silken_net/blob/main/config/environments/production.rb
      https://github.com/Alexey-Lukin/silken_net/blob/main/config/deploy.yml


    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.

    Met. TLS certificate verification is left at the secure default everywhere and is
    never disabled. A scan of the entire repository (app, lib, config, scripts, firmware,
    tools, contracts) finds no VERIFY_NONE, verify: false, ssl_verify false,
    verify_peer: false, "insecure", curl -k, or --no-check-certificate — nothing
    overrides certificate verification.

    • Outbound HTTPS uses standard clients at their defaults: the eth gem (Eth::Client,
      over Net::HTTP) for chain RPC and HTTPX for other services, both of which verify the
      server certificate by default (OpenSSL VERIFY_PEER) for https URLs. No custom
      SSLContext or verify_mode is set anywhere.
    • Subresources in the web UI (importmap JS, Leaflet) are loaded over HTTPS and a
      Content-Security-Policy restricts their origins, so the browser performs normal
      certificate verification on them as well.
      https://github.com/Alexey-Lukin/silken_net/blob/main/config/initializers/content_security_policy.rb


    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]

    Met. Private information is only sent over a connection whose certificate has been
    verified:

    • Server side: session cookies are flagged secure in production
      (config/initializers/session_store.rb: secure: Rails.env.production?, plus httponly
      and same_site: :lax), and config.force_ssl = true with HSTS (1 year,
      includeSubdomains, preload) guarantees the browser transmits the cookie only over
      HTTPS after verifying the server certificate, and never over plain HTTP (HSTS
      preload blocks downgrade).
    • Client side: outbound requests carrying private headers (e.g. Authorization: Bearer
      API keys to dClimate/Filecoin, the Chainlink HMAC signature, M2M tokens) are sent
      over HTTPS via Net::HTTP/HTTPX with default certificate verification (OpenSSL
      VERIFY_PEER), which is never disabled anywhere in the codebase — the TLS handshake,
      including certificate validation, completes before the request headers are sent.
      https://github.com/Alexey-Lukin/silken_net/blob/main/config/initializers/session_store.rb
      https://github.com/Alexey-Lukin/silken_net/blob/main/config/environments/production.rb

  • 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.

    Met. The project's public generated deliverable — the production container image
    mirrored to GHCR (ghcr.io/alexey-lukin/silken_net) for widespread use (e.g. Akash
    providers) — is cryptographically signed with a Sigstore-keyless SLSA
    build-provenance attestation produced by actions/attest-build-provenance in
    .github/workflows/mirror-ghcr.yml (GitHub Actions OIDC → Fulcio, logged in the
    public Rekor transparency log) and pushed to the registry alongside the image. The
    signing key is ephemeral (Fulcio-issued per build, never stored) — it is not on the
    distribution site. The documented user verification process is in SECURITY.md
    ("Verifying release artifacts"): gh attestation verify
    oci://ghcr.io/alexey-lukin/silken_net:<tag> --owner Alexey-Lukin. Source-tree
    commit/tag signing is tracked separately (OPS.10).
    https://github.com/Alexey-Lukin/silken_net/blob/main/.github/workflows/mirror-ghcr.yml
    https://github.com/Alexey-Lukin/silken_net/blob/main/SECURITY.md



    É 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]

    Met. The project's public generated deliverable — the production container image
    mirrored to GHCR (ghcr.io/alexey-lukin/silken_net) for widespread use (e.g. Akash
    providers) — is cryptographically signed with a Sigstore-keyless SLSA
    build-provenance attestation produced by actions/attest-build-provenance in
    .github/workflows/mirror-ghcr.yml (GitHub Actions OIDC → Fulcio, logged in the
    public Rekor transparency log) and pushed to the registry alongside the image. The
    signing key is ephemeral (Fulcio-issued per build, never stored) — it is not on the
    distribution site. The documented user verification process is in SECURITY.md
    ("Verifying release artifacts"): gh attestation verify
    oci://ghcr.io/alexey-lukin/silken_net:<tag> --owner Alexey-Lukin. Source-tree
    commit/tag signing is tracked separately (OPS.10).
    https://github.com/Alexey-Lukin/silken_net/blob/main/.github/workflows/mirror-ghcr.yml
    https://github.com/Alexey-Lukin/silken_net/blob/main/SECURITY.md


  • 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.

    Met — input is validated with an allowlist approach at every untrusted boundary:

    • HTTP/API: Rails strong parameters (params.require(...).permit(...)) accept only an
      explicit allowlist of attributes; everything else is dropped. Models add
      allowlist-style validations enforced before persistence — numbers are range-checked
      (actuator_command duration numericality: { greater_than: 0, less_than_or_equal_to:
      3600 }, ai_insight scores { in: 0.0..100.0 } / { in: 0.0..1.0 }), values are
      constrained to allowlists (inclusion: { in: %w[evm solana celo] }, inclusion: { in:
      HARDWARE_TYPES }), and strings are checked for syntax/length (format: { with: ... }
      for hex addresses/bytecode, length: { maximum: ... }). Invalid records are rejected.
    • Untrusted IoT telemetry (binary LoRa/CoAP): TelemetryUnpackerService validates the
      decoded packet (valid_sensor_data?) before processing and rejects malformed or
      out-of-range frames; it also enforces a SEC.10 panic-replay counter and CCM
      key-size checks.
    • On-chain (Solidity): every external function guards its inputs with require(...) —
      non-zero addresses, array-length equality, batch-size bounds (<= MAX_BATCH_SIZE),
      positive amounts — reverting on invalid input.
    • Oracle callbacks (Chainlink) are authenticated by HMAC before their payload is
      accepted.

    https://github.com/Alexey-Lukin/silken_net/blob/main/app/models/blockchain_transaction.rb
    https://github.com/Alexey-Lukin/silken_net/blob/main/app/services/telemetry_unpacker_service.rb



    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).

    Met (SHOULD). Hardening mechanisms are applied on both the web and firmware sides.

    Web (Rails — the network-facing attack surface):

    • A strict Content-Security-Policy (config/initializers/content_security_policy.rb):
      default_src/base_uri/form_action 'self', frame_ancestors 'none', frame_src 'none',
      object_src 'none', and a per-request nonce for inline scripts (no 'unsafe-inline'
      on script-src).
    • A full security-header set (config/initializers/security_headers.rb): X-Frame-Options
      DENY, X-Content-Type-Options nosniff, Referrer-Policy strict-origin-when-cross-origin,
      Cross-Origin-Opener-Policy / Cross-Origin-Resource-Policy same-origin, a restrictive
      Permissions-Policy, and X-XSS-Protection 0 (disables the legacy exploitable filter).
    • HSTS with preload (1 year, includeSubdomains) + config.force_ssl; session cookies are
      httponly + secure + same_site:lax.

    Firmware C (a memory-unsafe language → compiler hardening):

    • The entire host test suite is compiled and executed under AddressSanitizer +
      UndefinedBehaviorSanitizer (-fsanitize=address,undefined -fno-sanitize-recover=all) on
      every CI run, so undefined behavior, buffer overflows and use-after-free abort the build
      before release — the criterion's "compiler flags to eliminate undefined behavior"
      example. The host build also honors -fstack-protector-strong / -D_FORTIFY_SOURCE / RELRO.

    https://github.com/Alexey-Lukin/silken_net/blob/main/config/initializers/content_security_policy.rb
    https://github.com/Alexey-Lukin/silken_net/blob/main/firmware/test/Makefile



    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.

    Met. The project provides a structured security assurance case at
    docs/SECURITY_ASSURANCE_CASE.md. It states the top-level security claims; a threat
    model (assets, threat actors, and attack surfaces across the Soldier->Queen->Rails->chain
    pipeline); an explicit identification of every trust boundary and the guard that
    enforces it; an argument that Saltzer-Schroeder secure-design principles are applied,
    with code anchors; and an OWASP Top 10 (2021) table showing how each common
    implementation weakness is countered - followed by an honest residual-risk and
    assumptions section. Each claim is backed by the test / SAST / SCA evidence listed in
    the document.
    https://github.com/Alexey-Lukin/silken_net/blob/main/docs/SECURITY_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'.

    The static analyzers used are specifically designed to find common vulnerabilities: Brakeman targets Rails vulnerability classes (SQL injection, XSS, mass assignment, CSRF), CodeQL runs security queries mapped to CWE, Slither has detectors for common Solidity vulnerabilities (reentrancy, access control, arithmetic), and cppcheck flags memory/defect issues in C. CodeQL runs security queries mapped to CWE (GitHub default setup, across all six
    languages — Ruby, C/C++, C#, JS/TS, Python, Actions).
    https://github.com/Alexey-Lukin/silken_net/blob/main/.github/workflows/solidity_audit.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 ships memory-unsafe C firmware (STM32 Soldier/Queen + the One-Home libraries in firmware/common/), so N/A does not apply. Every host-based unit test (firmware/test/, ~22 binaries covering the untrusted-input parsers — AT-command/CoAP PDU tokenizer, circular-DMA UART RX ring, flash KV/ring/OTA journals with power-cut fault injection — plus the crypto, DSP and TinyML paths) is compiled and executed under AddressSanitizer + UndefinedBehaviorSanitizer on every CI run, via make -C firmware/test asan in the firmware_test job of .github/workflows/ci.yml (gating through the ci-ok aggregate required check). Flags: -fsanitize=address,undefined -fno-sanitize-recover=all -fno-omit-frame-pointer -g -O1. AddressSanitizer detects heap/stack/global buffer overflows (the explicit "buffer overwrite" concern), use-after-free/return and double-free; UndefinedBehaviorSanitizer detects signed-integer overflow, out-of-bounds shifts, misaligned/null pointer dereferences and invalid enum/bool loads; halt_on_error=1 makes the first finding fail the build. LeakSanitizer is intentionally disabled (detect_leaks=0) because the only allocations outliving main() are OpenSSL's one-time global init in two tests, which the short-lived test processes deliberately do not tear down — a "still reachable" false positive, not a memory-safety defect. This dynamic lane complements the existing static analysis (cppcheck firmware_lint, CodeQL c-cpp, and -Wall -Wextra -Wpedantic).
    https://github.com/Alexey-Lukin/silken_net/blob/main/firmware/test/Makefile



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

Entrada de selo do projeto de propriedade de: Alexey Lukin.
Entrada criada em 2026-06-24 13:17:00 UTC, última atualização em 2026-06-25 13:55:07 UTC. Selo de aprovação alcançado pela última vez em 2026-06-24 17:34:54 UTC.