Basis CLI

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

    Basis CLI is the command-line client for Basis Network. This repository — and this badge entry — is what distributes and verifies it: the download script that checks every binary against a SHA-256 committed to git, the checksums themselves, the release workflow that verifies each published asset and then signs it with Sigstore in keyless mode, the test suite covering all of that, and the documentation. The compiled basis binary is built from basis-core, which is not public yet. Everything in this repository is Apache-2.0 with its source, and every file carries its copyright and licence, checked in CI against version 3.3 of the REUSE Specification.

    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]

    The same document lists them: make check (the test suite) and make lint (shellcheck over both scripts, reuse lint over every file) must pass; a change to what download.sh does must come with a test; every new file needs an SPDX header or a REUSE.toml entry; every commit needs a Signed-off-by line. All of it is enforced by required CI checks on main, not just asked for. https://github.com/basis-network/basis-cli/blob/main/CONTRIBUTING.md#making-a-change


  • 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 1.1. CONTRIBUTING.md has a section explaining what signing off means, that it is not a copyright assignment, that the contributor keeps their copyright, and that it asserts the right to contribute the code. It shows git commit -s and the Signed-off-by line it produces, asks for a real name and a working address, and states that commits without a sign-off cannot be merged. Every commit in this repository carries the line, maintainers included. https://github.com/basis-network/basis-cli/blob/main/CONTRIBUTING.md#sign-your-work--the-dco



    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.

    GOVERNANCE.md documents the model. It is a small project with two maintainers, and it says so rather than describing a committee that does not exist. It names who has final say, how decisions are made for each class of change (documentation and script changes by pull request; anything that changes what the repository vouches for goes in the CHANGELOG with its reasoning), how someone becomes a maintainer, how releases are made, and how the document itself is changed. It is also explicit about what it cannot decide: the CLI's own behaviour is built from basis-core and that decision belongs to that team. https://github.com/basis-network/basis-cli/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.

    Contributor Covenant 2.1, at the standard location in the repository root, so GitHub surfaces it in the community profile and in the contribution flow. CONTRIBUTING.md links to it and states that participating means agreeing to it. Enforcement contact is conduct@basisnetwork.com.co, a mailbox that exists only for this and is read by the maintainers. https://github.com/basis-network/basis-cli/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.

    GOVERNANCE.md has a table of every role, who holds it, and what it obliges them to do: lead maintainer (final say, breaking ties), maintainer (reviewing and merging, committing checksums before a release is published, publishing releases, triaging issues), security contact (reading the private advisory queue, acknowledging within three working days, running the process in SECURITY.md to disclosure), licence compliance, and organisation owner. Both people are named with their GitHub accounts. One row is deliberately held by nobody — release signing — because it is keyless and performed by the release workflow under its own OIDC identity, so there is no key for a person to hold, lose, or be coerced into using. https://github.com/basis-network/basis-cli/blob/main/GOVERNANCE.md#the-roles-and-who-holds-them



    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]

    There are two maintainers, and they are equal in access rather than one being a nominal backup. Both are owners of the basis-network GitHub organisation and both are administrators of this repository, so either can open and close issues, accept proposed changes and publish a release without the other. That is well inside the one-week requirement — it needs no handover at all. There is no separate key or credential that would need recovering: releases are signed keylessly by the release workflow's OIDC identity, so nothing about publishing depends on a secret any individual holds. Two-factor authentication is required organisation-wide, and either owner can restore the other's access. https://github.com/basis-network/basis-cli/blob/main/GOVERNANCE.md#the-roles-and-who-holds-them



    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.

    Two. Both maintainers have identical repository and organisation access and either can release on their own, which is what the criterion measures. Being exact about what that buys is worth more than the number: it removes the single point of failure for access, for releases and for a vulnerability report going unread. It does not yet mean every change gets a second pair of eyes — that is two_person_review at gold level, and this project does not claim it. GOVERNANCE.md says both of those things in the same paragraph. https://github.com/basis-network/basis-cli/blob/main/GOVERNANCE.md#who-decides


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

    docs/ROADMAP.md covers the next twelve months and is split by what this repository can actually control. Scheduled here: a macOS build in the release matrix, signed version tags, recorded provenance for every published platform, branch coverage if a FLOSS tool for shell appears, and keeping the four documented rough edges accurate. Reported but not scheduled: the four CLI defects, which live in basis-core and cannot be fixed from here. It also lists what the project will not do — no long-term support branches, no CLI source in this repository, no binaries in git, no package-manager distribution before macOS ships, and no bug bounty — because a roadmap that only lists ambitions is half a document. https://github.com/basis-network/basis-cli/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.

    docs/ARCHITECTURE.md documents the major components (the download script, the committed checksums, the release workflow that verifies and signs, the CI workflows, the test suite), the relationships among them, and the key properties of those relationships. It includes the download data flow from both sources to the verified file on disk, the five load-bearing properties of that flow with the test case that guards each, and the four trust regions with the boundary crossing that matters. The design in one sentence: a release serves the binary and git serves the checksum, so no single party controls both. It also states what the architecture does not claim, which is anything about the binary's behaviour. https://github.com/basis-network/basis-cli/blob/main/docs/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.

    SECURITY.md has a "Security requirements" section stating what the tool guarantees and what it does not. Guarantees: integrity of what you download against a digest committed to git; fail-closed behaviour on any mismatch, missing checksum or missing hash tool; verification that does not depend on the network holding; Sigstore keyless signatures on every release asset with the certificate in the public Rekor log; and that nothing here touches a secret. Non-guarantees, stated just as plainly: nothing about the binary's behaviour, no protection against a compromised maintainer account, no availability guarantee, and nothing about the network the CLI talks to. https://github.com/basis-network/basis-cli/blob/main/SECURITY.md#security-requirements



    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's Install section is the quick start and it is the first thing after the description: clone, run ./download.sh, and you have a verified binary, with ./download.sh windows-x86_64 for the other platform. The by-hand equivalent with curl and sha256sum -c follows for readers who want to see what the script does before running it, and the section ends with the command that proves it worked. Three lines to something that runs. https://github.com/basis-network/basis-cli/blob/main/README.md#install



    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 is treated as part of the change, not as a follow-up. The review checklist in CONTRIBUTING.md makes it explicit: a change that makes a sentence in the README wrong includes the fix for that sentence, and a reviewer is expected to check it. The rough edges in the README are written against the running devnet rather than assumed, and the roadmap says they move to the CHANGELOG as they are fixed upstream instead of quietly disappearing. Two known documentation defects were found and fixed in the course of this review rather than left: .gitignore described binaries as served from a storage bucket when they are attached to GitHub releases, and the Makefile said CI ran two targets when it now runs three. The CHANGELOG records what changed and what it means for each release.



    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 README opens with badges for lint, test, OpenSSF Best Practices, OpenSSF Scorecard, REUSE and the licence, and has an Achievements section that links each certification to its report — the Best Practices entry, the Scorecard viewer result and the REUSE information page — rather than to a marketing page, so a reader can check the claim instead of trusting the badge. That section also states what the achievements cover: this repository, the distribution and verification tooling, not the compiled binary. The passing badge was added the day it was earned. https://github.com/basis-network/basis-cli#achievements


  • 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 results are a command-line script and plain-text documentation, which the criterion notes are fairly accessible as-is, and the practices that do apply were followed rather than assumed. Output is plain text on stdout and stderr with no cursor addressing, no colour and no box drawing, so a screen reader gets it in order and nothing is conveyed by colour alone. Progress and results are short single lines rather than redrawn regions, so there is no overdraw for a screen reader to re-read. Errors state the problem in words on stderr and set a non-zero exit status, so the failure is available both to a person and to a program. The project sites are GitHub, whose accessibility we do not control but which is maintained to WCAG, and the documentation is Markdown with real headings, tables with header rows and descriptive link text rather than "click here".



    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 produced by this project is a download-and-verify script whose entire output is a handful of operational status lines aimed at a developer at a terminal — the version and platform being fetched, the asset mapping, and the verification result. It generates no end-user-facing text, has no user interface, and sorts nothing human-readable: the only ordering it does is version sorting with sort -V, which is numeric and locale-independent by design. There is nothing here to localise, and internationalising status lines that exist to be read next to a stack trace would add a message catalogue and a dependency without helping anyone.


  • 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 sites do not store passwords for authenticating external users. The website, the repository and the download URLs are all GitHub, which handles its own authentication — the criterion's own details note that using GitHub meets it. This project operates no login of its own, has no user accounts, and stores no credential of any kind: there is no database, no session, and no server-side code in this repository at all.


 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]

    Only the latest release is supported, and there is a documented upgrade path that is a single command: re-running ./download.sh fetches and verifies the newest version this repository knows about, because the version is resolved from checksums/ by version sort rather than pinned. SECURITY.md states the support policy and why — this tracks a development network that may be reset without notice, so pinning an old client to a chain that no longer exists helps nobody — and the roadmap repeats it as a deliberate non-goal rather than an omission. The upgrade is not difficult: there is no state to migrate, no configuration file, and no installed footprint beyond the binary itself. The CHANGELOG records what changed between versions and what it means.


 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]
  • 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 vulnerabilities have been reported or resolved in this repository in the last 12 months — the repository has existed since August 2026 and has had no vulnerability reports at all, so there is nobody to credit yet. The policy for when there is one is already written rather than improvised at the time: SECURITY.md states that reporters are credited in the release notes unless they ask not to be, and the documented handling process ends with the advisory published, the CHANGELOG saying what changed and why, and the reporter credited. https://github.com/basis-network/basis-cli/blob/main/SECURITY.md#reporting-a-vulnerability



    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.

    SECURITY.md documents the process end to end in six steps: acknowledge the reporter and open a GitHub private security advisory (so an emailed report ends up in the same place, visible to the reporter); triage — reproduce, and decide whether it falls inside this repository's security boundary or belongs to basis-core or the network, forwarding it and saying where it went if it does not; record severity, scope and affected versions in the advisory; fix on a branch with a regression test where the defect is testable from here, reviewed before merge; release, with checksums committed before publication and assets verified and signed by the release workflow; disclose, with the advisory published, the CHANGELOG explaining the change and the reporter credited, timing agreed with them. A report that turns out not to be a vulnerability gets told why rather than left waiting. Committed timelines: acknowledgement within 3 working days, first assessment within 10, a fix or a stated plan within 90 days. https://github.com/basis-network/basis-cli/blob/main/SECURITY.md#how-a-report-is-handled


 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 primary language is bash, and CONTRIBUTING.md names the Google Shell Style Guide as the standard contributions follow, with two deliberate differences stated rather than left to be discovered: comments explain why and not what, and indentation is two spaces to match the existing scripts. It also states the conventions for the other file types here — YAML workflows two-space indented with every action pinned to a commit SHA, Markdown wrapped at 80 columns — and requires that a silenced lint rule carries a # shellcheck disable= directive at the line it applies to with a reason, never file-wide. https://github.com/basis-network/basis-cli/blob/main/CONTRIBUTING.md#coding-style



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

    shellcheck is the FLOSS tool for this language and it runs in CI on every push and every pull request, over download.sh, test/run.sh and test/coverage.sh. It is a required status check on the protected main branch, so a violation blocks the merge rather than producing a warning somebody may or may not read; the same command is available locally as make lint. Exceptions are allowed but must be per-line # shellcheck disable= directives with a reason at the point they apply, so they are reviewable and can be handled automatically later. There are currently none: the tree is clean with no suppressions at all.


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

    No native binaries are generated by this project. There is no compiler and no linker involved anywhere in this repository: the software it produces is bash read by an interpreter as it is, and the Makefile has no build target — only check, coverage and lint. The compiled basis binary is built elsewhere, from basis-core, which is outside this entry's declared scope. There are therefore no CC, CFLAGS, CXX, CXXFLAGS or LDFLAGS for anything here to honour or override.



    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 build or installation system that could strip anything. Nothing is compiled, so no debugging information is generated in the first place, and download.sh copies bytes and verifies a digest rather than installing with install -s or anything like it. The script it produces is its own source and is fully readable at run time.



    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.

    There is no build system to be recursive. The Makefile is flat, has no build target, no subdirectory makefiles and no cross-directory dependencies: each target is a single command that runs a script in place. Nothing is compiled, so there is no dependency graph that could be got wrong.



    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.

    No building occurs. This is a scripting-language project: download.sh and test/run.sh are used directly by the interpreter, not compiled into anything, so there is no generated artefact whose bit-for-bit reproduction could be compared. Reproducibility of the compiled binary is a property of basis-core, outside this entry's scope, and is listed as a known gap in the assurance case rather than claimed here.


  • 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 is ./download.sh, which is the commonly-used convention for this kind of tool — a single verified-download script, the same pattern as rustup or the many curl | sh installers, except that this one refuses to proceed if it cannot verify what it fetched. The README documents it as the first thing after the description, along with the by-hand curl plus sha256sum -c equivalent for readers who want to do it themselves. Uninstallation is equally simple and is a real answer rather than a dodge: everything the script produces lives under bin/<platform>/ inside the clone, nothing is written outside it, no system directory is touched, no service is registered and no configuration file is created anywhere. Deleting the directory removes the tool completely.



    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]

    There is no installation system that writes outside its own directory, so there is no standard convention to honour. download.sh writes only to bin/<platform>/ relative to the script's own location; it installs nothing into a system prefix, so DESTDIR and PREFIX have nothing to select. Where the binary goes afterwards is the user's choice, made with mv or by adding that directory to PATH.



    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.

    Clone the repository and run make check. That is the whole development environment: the suite needs nothing that download.sh itself does not need — bash, curl and a SHA-256 tool, all present on a stock Linux or macOS — and it touches no network, because each case fabricates a throwaway release in a temporary directory and reaches it over file://. There is nothing to install, no language runtime to provision, no container to build and no fixture to download. make lint adds shellcheck and reuse, and make coverage adds bashcov (gem install bashcov); both are documented in CONTRIBUTING.md and neither is needed to make and test a change.


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

    This repository ships no code dependencies — no package manifest, no vendored code, nothing from a language registry — and the two classes of external dependency it does have are both listed in a computer-processable way. The GitHub Actions the workflows call are declared in the workflow YAML with every action pinned to a commit SHA and the version in a trailing comment, which is the convention for that ecosystem and is what Dependabot reads; .github/dependabot.yml declares the github-actions ecosystem so those declarations are watched weekly. The run-time dependencies are the operating system's own bash, curl and sha256sum or shasum, which is why there is no manifest to add them to; the README and CONTRIBUTING.md both state them, and the script itself checks for the SHA-256 tool at run time and exits if it is missing. https://github.com/basis-network/basis-cli/blob/main/.github/dependabot.yml



    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.

    Dependabot runs weekly over the github-actions ecosystem and opens a pull request when a pinned action moves, which is the whole point of the configuration: pinning to a commit SHA makes an action safe but not current, and without something watching, a pin quietly rots. Six such updates have already been merged. Those pull requests run the same required CI as any other change, so an update cannot land broken. GitHub's own vulnerability alerting is enabled on the repository, CodeQL analyses the workflows on every push and weekly, and OpenSSF Scorecard publishes a Vulnerabilities check result publicly on every push. There are no other external components: no language-registry dependencies and no convenience copies of anything.



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

    Everything reused is the standard component provided by the system. The script uses the operating system's bash, curl and sha256sum or shasum, all updated by the system package manager, and there are no convenience copies, no vendored libraries and no forked standard components anywhere in the tree — so a security update to any of them takes effect immediately, with nothing here holding an old copy alive. The only other reused components are the GitHub Actions, which are pinned by commit SHA and therefore trivially identifiable, and Dependabot updates them weekly.



    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]

    Nothing deprecated or obsolete is used. The script's entire external surface is POSIX-standard utilities and current curl options, with no shell builtin or flag that has been deprecated; shellcheck runs in CI specifically to catch constructs that are obsolete or fragile, and the tree is clean with no suppressions. The CI side is kept current by Dependabot: all GitHub Actions are on their current major versions, and when a whole family had to move together — every codeql-action reference from v3 to v4 — it was done in a single change rather than left half-migrated.


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

    .github/workflows/test.yml runs the full suite on every push to main and every pull request targeting it, via make check. It reports success or failure as a GitHub status check — download.sh test suite — which is required on the protected branch, so a failing suite blocks the merge rather than being noticed later. The suite is nine cases and 28 assertions covering the whole download-and-verify path end to end, including the two failure paths that justify the repository. A second job in the same workflow measures statement coverage and fails below 90%.



    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]

    No bugs have been fixed in this repository in the last six months, so there is no denominator: the repository was made public in August 2026, has had no bug reports against download.sh and no defect fixes to add regression tests for. The policy for when there is one is already in place rather than to be decided later — CONTRIBUTING.md requires that a change to what download.sh does comes with a test, the review checklist makes a behaviour change without a test a blocking comment, and SECURITY.md's handling process specifies a regression test as part of fixing a reported vulnerability. Two of the nine existing cases are failure paths written for exactly this purpose.



    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.

    Measured, not estimated: 98.1% statement coverage of download.sh, 52 of 53 statements. make coverage runs the suite under bashcov, the FLOSS coverage tool for bash, and CI runs it as its own job on every push and every pull request, failing the job below a hard floor of 90% — so a regression shows up as a red check on the pull request that caused it. Getting an honest figure needed two things that are documented in test/coverage.sh: the suite deletes each sandbox when its case ends, taking the traced copy of the script with it, so BASIS_TEST_KEEP keeps them; and SimpleCov silently drops any path with a dot-prefixed component, which yields a confident 0% with no error. Each case traces its own copy of the same bytes, so the copies are summed per line. One line is reported uncovered and is not — the done carrying the loop's redirection, which bash attributes to the while — and it is left in the report rather than special-cased, because a coverage tool taught to lie about one line stops being evidence about the others.


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

    CONTRIBUTING.md states it as a rule, not a suggestion: "A change to what download.sh does comes with a test." It goes on to say why, which is what makes it stick — the script exists to refuse a download that does not match the committed checksum, and a refusal that stops working is silent. The same document requires make check to pass and asks contributors to say in the pull request which case covers their change, and the review checklist makes a behaviour change with no covering test a blocking comment. SECURITY.md applies the same rule to vulnerability fixes.



    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.

    It is written down in CONTRIBUTING.md, in the section a contributor reads before opening a pull request, and repeated as a checklist item in the pull request template. https://github.com/basis-network/basis-cli/blob/main/CONTRIBUTING.md#tests


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

    shellcheck runs at its default severity, which is the lowest one and therefore reports everything from style upwards, over every script in the repository, with no exclusions and no suppressions. Its optional --enable=all checks were reviewed and not adopted: they are formatting preferences (brace every variable reference, prefer [[ ]] to [ ]) rather than defect detection, and adopting them would mean rewriting working code to a house style it does not use.


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

    docs/ASSURANCE-CASE.md works through Saltzer and Schroeder principle by principle with the concrete application in each row. The ones that carry the design: fail-safe defaults — every path denies by default, and no checksum file, no hash tool or a digest mismatch each end in a non-zero exit with the binary never made executable; separation of privilege — subverting a download requires control of both the release and the git history, two mechanisms with different failure modes and different audiences; economy of mechanism — about 110 lines of bash, no dependency manifest, no configuration file and no persistent state, so the whole verification argument fits on a page; complete mediation — every name in the checksum file is verified, not just the first, which the multi-entry test case guards; least privilege — workflows are read-all by default and elevated per job only where genuinely needed. Where principles conflict the choice is stated rather than hidden.


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

    No SHA-1 and no CBC-mode SSH: the only hash is SHA-256 and the only transport is TLS as curl negotiates it. (git names its own objects with SHA-1, which is a property of the version control system rather than of anything this project produces or verifies with — the integrity guarantee this repository makes rests on the SHA-256 in checksums/, not on a commit id.)



    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 verification format is the standard sha256sum/shasum -c file, which is not tied to a single implementation and already runs through two interchangeable back ends selected at run time: sha256sum where it exists and shasum -a 256 where it does not, which is what macOS ships. The digest algorithm lives in the checksum files under checksums/<tag>/<platform>.sha256 rather than being compiled into logic, so moving to another algorithm is a new file set and a matching shasum -a selection, not a redesign. SHA-256 is a current SHA-2 algorithm with no known weakness relevant here, and there is no cipher suite or key exchange in this project to negotiate: the signatures on release assets are Sigstore's, whose algorithm agility is that project's.



    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]

    This project never processes authentication credentials or private cryptographic keys. download.sh authenticates to nothing, sends no credential, reads no keystore, prompts for no passphrase, and stores nothing — it fetches a public release asset over HTTPS and hashes it. Release signing is Sigstore keyless: the identity is the release workflow's short-lived OIDC token and there is no private key in the repository, in CI, or anywhere for a person to hold. SECURITY.md states plainly that nothing here, download.sh included, touches key material of any kind.



    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]

    All network communication is HTTPS. download.sh fetches from https://github.com/<repo>/releases/download by default, and curl verifies the certificate chain by default with no flag anywhere in this project disabling it — there is no --insecure, no -k and no GIT_SSL_NO_VERIFY-style escape hatch. The base URL can be overridden by BASIS_CLI_BASE_URL, which exists so the test suite can point at a local directory over file:// without touching the network; that is an explicit action by the user, which is exactly the condition the criterion allows. Nothing insecure is enabled by default and no plaintext protocol is used at all.



    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]

    TLS is used through the system's curl and its TLS library, so the project supports whatever they do, which on any currently supported platform is TLS 1.2 and 1.3. The script pins no version, disables nothing and offers no option to downgrade, so a system hardened to 1.2-or-better stays that way. GitHub, the only host contacted by default, requires TLS 1.2 as a minimum on its side.



    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.

    Certificate verification is on, by default, and cannot be turned off from here. download.sh invokes curl -fSL --retry 3 --retry-delay 2, and curl verifies the certificate chain and hostname by default; this project passes no --insecure, no -k, no --cacert override and sets no environment variable that would weaken it. There are no subresources: one request per asset named in the checksum file, all to the same host. A failed verification makes curl exit non-zero, and with set -euo pipefail the script stops there. Worth noting that the integrity guarantee does not rest on this anyway: even a fully broken TLS connection cannot produce a binary matching a digest committed to git.



    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]

    The software sends no private information over TLS at all — no HTTP headers carrying credentials, no cookies, no tokens, no authentication of any kind. download.sh issues unauthenticated GET requests for public release assets; there is nothing private that could be sent before or after verification. The CLI's inability to send an Authorization header is documented in the README as one of its known limitations. Certificate verification is nonetheless on by default for every request, as answered in crypto_certificate_verification.


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

    Every release asset is cryptographically signed with Sigstore cosign in keyless mode by .github/workflows/release.yml, which fires on release: published — deliberately not on a tag push — so what is signed is exactly what people download rather than a rebuild that resembles it. Before signing, the workflow verifies every published asset against the checksums committed to git, so a mismatch fails loudly instead of being signed. The private key requirement is met in the strongest available form: there is no private key at all. The signing identity is the workflow's short-lived OIDC token and the certificate is recorded in the public Rekor transparency log, so nothing persistent exists on the distribution site or anywhere else to be stolen. SECURITY.md documents verification with a complete cosign verify-blob command including the certificate identity and OIDC issuer to pin against, and the README links to it. Independently of the signatures, every release also has its SHA-256 committed to this repository before publication. https://github.com/basis-network/basis-cli/blob/main/SECURITY.md#signatures



    É 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 release assets are signed; the git tags they come from are not. This is answered honestly rather than stretched: signing tags needs a personal signing key held by a maintainer, and the project has deliberately avoided having one anywhere — asset signing is keyless precisely so that no individual holds a key that can be stolen or coerced. Adding tag signing is a real improvement and is on the roadmap as item 2, because it would close the gap between "this binary was published by our workflow" and "this tag is the one the maintainers made". Until it is done, the answer is Unmet.


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

    Every input from a potentially untrusted source is checked against an allowlist before it is used, and rejected if it does not match. The platform argument is not interpolated into a URL on trust: it must correspond to an existing checksums/<version>/<platform>.sha256 file, and anything else exits 1 listing the versions and platforms that do exist — a test case covers exactly that. The version is resolved from the directories that exist in checksums/, so it cannot name something arbitrary. The checksum file is the input that matters most, and CI validates its format with an allowlist on both fields: each digest must be exactly 64 lowercase hex characters, and each file name must be basis or basis.exe — nothing else parses, which is also what stops a ../ name reaching the download loop. The downloaded bytes themselves are the untrusted input the whole project exists to check, and they are verified against the committed digest before anything is made executable. Every shell expansion is quoted, enforced by shellcheck in CI.



    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 hardening available to a shell script is applied. set -euo pipefail is the first executable line: an unset variable, a failing command or a failing pipeline stage aborts rather than continuing with a wrong value — the failure mode that turns a shell defect into a security problem. Every expansion is quoted and shellcheck enforces it in CI as a required check. The script asks for no privilege and writes only under its own bin/ directory, touching no system location. On the CI side, which is the part of this project with credentials: permissions: read-all at workflow level with elevation per job only where genuinely needed, persist-credentials: false on every checkout, and every action pinned to a commit SHA rather than a mutable tag. The project sites are GitHub, which serves Content-Security-Policy, HSTS, X-Content-Type-Options and X-Frame-Options.



    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.

    docs/ASSURANCE-CASE.md contains all four required parts. Threat model: six adversaries described by capability rather than identity — network attacker, release attacker, repository attacker, compromised CI, hostile user environment, and the tooling supply chain — each with the mechanism that counters it, the test case or workflow that evidences it, and the residual risk that remains. Trust boundaries: four regions, with the one security-relevant crossing identified as untrusted bytes entering a machine checked against a digest that came the other way. Secure design: Saltzer and Schroeder row by row with the concrete application of each. Implementation weaknesses: CWE-494, 347, 829, 78, 22 and 367 answered individually, with the inapplicable half of the OWASP list named as inapplicable rather than silently skipped. It also states the claim it does not make — nothing about the compiled binary's behaviour — and ends with the known gaps, including that single-maintainer review is the dominant residual risk. https://github.com/basis-network/basis-cli/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'.

    CodeQL's Actions query pack is written for exactly the vulnerabilities of this environment — expression injection, excessive GITHUB_TOKEN permissions, artifact poisoning, unpinned actions. OpenSSF Scorecard also runs against the repository weekly and on every push to main. https://scorecard.dev/viewer/?uri=github.com/basis-network/basis-cli


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

    Nothing in this repository is written in a memory-unsafe language. It is shell, YAML and Markdown. (The CLI it distributes is Rust, and is outside the scope of this entry.)



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

Entrada de selo do projeto de propriedade de: Sebastian.
Entrada criada em 2026-08-24 15:57:55 UTC, última atualização em 2026-08-26 02:10:48 UTC. Selo de aprovação alcançado pela última vez em 2026-08-24 16:56:42 UTC.