tsong

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


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

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

        

 Fundamentos 1/5 ●

  • Geral

    Observe que outros projetos podem usar o mesmo nome.

    Tsong is an API gateway and RFC 8693 token exchange issuer that centralizes access-token validation. It validates every caller's token against the identity providers you trust, such as Entra, Okta or GitLab, enforcing each route's audience, scope and IP policy from a single config file, and replaces the token with one Tsong signs and scopes to that route. Services then trust one issuer and one JWKS instead of many, and never see the caller's original token. Every check is mandatory: config sets the values, never turns a check off. The config can live in Git and reload on push, with each new version fully validated before it replaces the last.

    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 selo de nível prata. [achieve_silver]

  • Supervisão do projeto


    O projeto DEVE ter um "fator ônibus" 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.

    Tsong has one maintainer. GOVERNANCE.md describes how a contributor can become a second maintainer, and a designated successor covers continuity.



    O projeto DEVE ter pelo menos dois contribuidores significativos não associados. (URL obrigatória) [contributors_unassociated]
    Os contribuidores são associados se forem pagos para trabalhar pela mesma organização (como empregado ou contratado) e a organização se beneficia dos resultados do projeto. Concessões financeiras não contam como sendo da mesma organização se passarem por outras organizações (por exemplo, concessões científicas pagas a diferentes organizações de uma fonte governamental ou ONG comum não fazem com que os contribuidores sejam associados). Alguém é um contribuidor significativo se fez contribuições não triviais para o projeto no último ano. Exemplos de bons indicadores de um contribuidor significativo são: escreveu pelo menos 1.000 linhas de código, contribuiu com 50 commits, ou contribuiu com pelo menos 20 páginas de documentação.

    Tsong has one human contributor so far. Small tasks for new contributors are open as good first issue: https://github.com/marklauter/tsong/labels/good%20first%20issue


  • Outro


    O projeto DEVE incluir uma declaração de licença em cada arquivo-fonte. Isso PODE ser feito incluindo o seguinte dentro de um comentário perto do início de cada arquivo: SPDX-License-Identifier: [expressão de licença SPDX para o projeto]. [license_per_file]
    Isso PODE também ser feito incluindo uma declaração em linguagem natural identificando a licença. O projeto PODE também incluir uma URL estável apontando para o texto da licença, ou o texto completo da licença. Observe que o critério license_location requer que a licença do projeto esteja em um local padrão. Veja este tutorial SPDX para mais informações sobre expressões de licença SPDX. Observe a relação com copyright_per_file, cujo conteúdo normalmente precederia as informações de licença.

    Not yet; issue #46 adds an SPDX-License-Identifier line to every source file, checked in CI by reuse lint. https://github.com/marklauter/tsong/issues/46


 Controle de Mudanças 4/4 ●

  • Repositório de código-fonte público controlado por versão


    O repositório de código do projeto DEVE usar um software de controle de versão distribuído comum (por exemplo, git ou mercurial). [repo_distributed]
    O Git não é especificamente exigido e os projetos podem usar software de controle de versão centralizado (como subversion) com justificativa.

    Repository on GitHub, which uses git. git is distributed. https://github.com/marklauter/tsong/releases



    O projeto DEVE identificar claramente pequenas tarefas que podem ser realizadas por novos colaboradores ou colaboradores casuais. (URL obrigatória) [small_tasks]
    Esta identificação é tipicamente feita marcando problemas selecionados em um rastreador de problemas com uma ou mais tags que o projeto usa para o propósito, por exemplo, up-for-grabs, first-timers-only, "Small fix", microtask ou IdealFirstBug. Essas novas tarefas não precisam envolver a adição de funcionalidade; elas podem ser melhorar a documentação, adicionar casos de teste ou qualquer outra coisa que ajude o projeto e ajude o colaborador a entender mais sobre o projeto.

    Small tasks for new or casual contributors are open issues labeled good first issue, each with what to do and when it is done: https://github.com/marklauter/tsong/labels/good%20first%20issue



    O projeto DEVE exigir autenticação de dois fatores (2FA) para desenvolvedores para alterar um repositório central ou acessar dados sensíveis (como relatórios de vulnerabilidade privados). Este mecanismo 2FA PODE usar mecanismos sem mecanismos criptográficos, como SMS, embora isso não seja recomendado. [require_2FA]

    GitHub requires 2FA as of March 2023. [osps_ac_01_01]



    A autenticação de dois fatores (2FA) do projeto DEVERIA usar mecanismos criptográficos para evitar personificação. A autenticação 2FA baseada em Short Message Service (SMS), por si só, NÃO atende a este critério, pois não é criptografada. [secure_2FA]
    Um mecanismo de 2FA que atende a este critério seria um aplicativo de Time-based One-Time Password (TOTP) que gera automaticamente um código de autenticação que muda após um determinado período de tempo. Observe que o GitHub suporta TOTP.

    The maintainer's second factor is a passkey, a public-key credential bound to github.com, which a phishing site cannot replay; no SMS factor is used


 Qualidade 7/7 ●

  • Padrões de codificação


    O projeto DEVE documentar seus requisitos de revisão de código, incluindo como a revisão de código é conduzida, o que deve ser verificado e o que é necessário para ser aceitável. (URL obrigatória) [code_review_standards]
    Veja também two_person_review e contribution_requirements.

    CONTRIBUTING.md lists what every pull request must pass to merge: formatting, lints with restriction lints, docs, tests in two profiles, 95% line coverage, mutation testing of changed lines, cargo audit, cargo-deny, fuzzing, CodeQL and a DCO sign-off. GOVERNANCE.md says the maintainer reviews and decides each pull request and gives reasons. https://github.com/marklauter/tsong/blob/main/CONTRIBUTING.md#what-a-pull-request-needs



    O projeto DEVE ter pelo menos 50% de todas as modificações propostas revisadas antes do lançamento por uma pessoa diferente do autor, para determinar se é uma modificação que vale a pena e livre de problemas conhecidos que argumentariam contra sua inclusão [two_person_review]

    Changes are pair-programmed: the maintainer and an AI coding assistant (Claude) discuss the problem and agree the design, the assistant writes the code, and the maintainer, a person other than the code's author, reviews every change before it merges. Each pull request also gets automated code and security review, and must pass the required CI checks. https://github.com/marklauter/tsong/pulls?q=is%3Apr+is%3Amerged


  • Sistema de compilação funcional


    O projeto DEVE ter uma compilação reproduzível. 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). (URL obrigatória) [build_reproducible]
    Uma compilação reproduzível significa que várias partes podem refazer independentemente o processo de geração de informações a partir de arquivos fonte e obter exatamente o mesmo resultado bit a bit. Em alguns casos, isso pode ser resolvido forçando algum tipo de ordenação. Desenvolvedores JavaScript podem considerar usar npm shrinkwrap e webpack OccurrenceOrderPlugin. Usuários de GCC e clang podem achar útil a opção -frandom-seed. O ambiente de compilação (incluindo o conjunto de ferramentas) pode frequentemente ser definido para partes externas especificando o hash criptográfico de um contêiner específico ou máquina virtual que eles podem usar para recompilar. O projeto de compilações reproduzíveis tem documentação sobre como fazer isso.

    scripts/reproducible.sh builds the release binary twice, from two copies of the tree in different directories, and fails unless the two are identical bit for bit; the weekly workflow runs it, and releases are built by the same script. https://github.com/marklauter/tsong/blob/main/scripts/reproducible.sh


  • Conjunto de testes automatizados


    Um conjunto de testes DEVE ser invocável de forma padrão para aquela linguagem. (URL obrigatória) [test_invocation]
    Por exemplo, "make check", "mvn test", ou "rake test" (Ruby).

    cargo test --workspace, the standard Rust invocation, runs the test suite, as the README describes. https://github.com/marklauter/tsong#development



    O projeto DEVE implementar integração contínua, onde o código novo ou alterado é frequentemente integrado em um repositório de código central e testes automatizados são executados no resultado. (URL obrigatória) [test_continuous_integration]
    Na maioria dos casos, isso significa que cada desenvolvedor que trabalha em tempo integral no projeto integra pelo menos diariamente.

    Every change reaches main through a pull request. GitHub Actions runs formatting, clippy, the tests in two profiles, coverage, cargo audit, cargo-deny, fuzzing, mutation testing, CodeQL and a DCO check on each, and the required checks must pass before it merges. https://github.com/marklauter/tsong/blob/main/.github/workflows/rust.yml



    O projeto DEVE ter conjunto(s) de testes automatizados FLOSS que fornecem pelo menos 90% de cobertura de instrução se houver pelo menos uma ferramenta FLOSS que possa medir este critério na linguagem selecionada. [test_statement_coverage90]

    CI fails a pull request whose line coverage falls below 95%, measured with cargo-llvm-cov.



    O projeto DEVE ter conjunto(s) de testes automatizados FLOSS que fornecem pelo menos 80% de cobertura de ramos se houver pelo menos uma ferramenta FLOSS que possa medir este critério na linguagem selecionada. [test_branch_coverage80]

    The test suite covers 96.5% of branches (426 branches, 15 missed), measured with cargo llvm-cov --branch on the pinned nightly toolchain, a FLOSS tool. https://github.com/marklauter/tsong/issues/47


 Segurança 5/5 ●

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

    O software produzido pelo projeto DEVE 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 DEVEM 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]

    Tsong is infrastructure that delegates inbound TLS to a separate network component: it is deployed behind a load balancer that terminates TLS, as ARCHITECTURE.md describes, and its own listeners speak plain HTTP to that component only. Every connection Tsong makes itself is encrypted: TLS 1.2 or 1.3 through rustls to downstreams and trusted issuers, which config validation requires to be https, and SSH for Git. https://github.com/marklauter/tsong/blob/main/ARCHITECTURE.md



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

    Tsong's TLS is rustls, which supports only TLS 1.2 and 1.3.


  • Entrega protegida contra ataques man-in-the-middle (MITM)


    O site do projeto, repositório (se acessível via web) e site de download (se separado) DEVEM incluir cabeçalhos de fortalecimento chave com valores não permissivos. (URL obrigatória) [hardened_site]
    Observe que o GitHub e o GitLab são conhecidos por atender a isso. Sites como https://securityheaders.com/ podem verificar isso rapidamente. Os principais cabeçalhos de proteção são: Content Security Policy (CSP), HTTP Strict Transport Security (HSTS), X-Content-Type-Options (como "nosniff") e X-Frame-Options. Sites web totalmente estáticos sem capacidade de fazer login por meio das páginas web poderiam omitir alguns cabeçalhos de proteção com menos risco, mas não há maneira confiável de detectar tais sites, portanto exigimos esses cabeçalhos mesmo se forem sites totalmente estáticos.

    The project site, repository and downloads are all on GitHub, https://github.com/marklauter/tsong, which serves Strict-Transport-Security with preload, a restrictive Content-Security-Policy, X-Frame-Options: deny and X-Content-Type-Options: nosniff.


  • Outras questões de segurança


    O projeto DEVE ter realizado uma revisão de segurança nos últimos 5 anos. Esta revisão DEVE considerar os requisitos de segurança e o limite de segurança. [security_review]
    Isso PODE ser feito pelos membros do projeto e/ou uma avaliação independente. Esta avaliação PODE ser apoiada por ferramentas de análise estática e dinâmica, mas também deve haver revisão humana para identificar problemas (particularmente no projeto) que as ferramentas não conseguem detectar.

    Every change is security-reviewed before it merges, and the assurance case reviews the whole system against its security requirements and trust boundaries, with the evidence for each. https://github.com/marklauter/tsong/blob/main/docs/notes/assurance-case.md



    Mecanismos de proteção DEVEM ser usados no software produzido pelo projeto para que defeitos de software tenham menos probabilidade de resultar em vulnerabilidades de segurança. (URL obrigatória) [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).

    Tsong is safe Rust: the workspace forbids unsafe code, so the compiler rules out undefined behavior such as buffer overflows and use-after-free, and lints deny panics, unwrap and unchecked indexing. The release binary is a position-independent executable with full RELRO (relro and bind-now) and a non-executable stack. Parsers of untrusted input use checked arithmetic, and fuzzing runs with overflow checks and AddressSanitizer. https://github.com/marklauter/tsong/blob/main/Cargo.toml


 Análise 2/2 ●

  • Análise dinâmica de código


    O projeto DEVE aplicar pelo menos uma ferramenta de análise dinâmica a qualquer lançamento de produção proposto do software produzido pelo projeto antes de seu lançamento. [dynamic_analysis]
    Uma ferramenta de análise dinâmica examina o software executando-o com entradas específicas. Por exemplo, o projeto PODE usar uma ferramenta de fuzzing (por exemplo, American Fuzzy Lop) ou um scanner de aplicação web (por exemplo, OWASP ZAP ou w3af). Em alguns casos, o projeto OSS-Fuzz pode estar disposto a aplicar testes de fuzzing ao seu projeto. Para fins deste critério, a ferramenta de análise dinâmica precisa variar as entradas de alguma forma para procurar vários tipos de problemas ou ser um conjunto de testes automatizado com pelo menos 80% de cobertura de ramificação. A página da Wikipedia sobre análise dinâmica e a página da OWASP sobre fuzzing identificam algumas ferramentas de análise dinâmica. A(s) ferramenta(s) de análise PODEM estar focadas em procurar vulnerabilidades de segurança, mas isso não é obrigatório.

    Tsong is fuzzed with cargo-fuzz (libFuzzer with AddressSanitizer). Five targets cover the parsers that read hostile input: bearer tokens through the validator, config and bootstrap TOML, X-Forwarded-For, the token endpoint form, and webhook deliveries. Every pull request fuzzes each target for 20 seconds, and a weekly workflow fuzzes each for ten minutes. proptest also runs generated inputs against client addressing, route policy and token minting: 256 cases per property on every pull request and 100,000 weekly. A release is cut from main, so its code has passed both.



    O projeto DEVERIA incluir muitas asserções em tempo de execução no software que produz e verificar essas asserções durante a análise dinâmica. [dynamic_analysis_enable_assertions]
    Este critério não sugere habilitar asserções durante a produção; isso é inteiramente decisão do projeto e de seus usuários. O foco deste critério é, em vez disso, melhorar a detecção de falhas durante a análise dinâmica antes da implantação. Habilitar asserções no uso em produção é completamente diferente de habilitar asserções durante a análise dinâmica (como testes). Em alguns casos, habilitar asserções no uso em produção é extremamente imprudente (especialmente em componentes de alta integridade). Existem muitos argumentos contra habilitar asserções em produção, por exemplo, bibliotecas não devem travar chamadores, sua presença pode causar rejeição por lojas de aplicativos e/ou ativar uma asserção em produção pode expor dados privados, como chaves privadas. Observe que em muitas distribuições Linux NDEBUG não é definido, então assert() em C/C++ será habilitado por padrão para produção nesses ambientes. Pode ser importante usar um mecanismo de asserção diferente ou definir NDEBUG para produção nesses ambientes.

    Tsong checks its code invariants with debug_assert!, such as canonical client addresses, minted scopes held and allowed, no reserved claims mapped, and each active key filed under its own algorithm. They run in the test suite, in the property tests and in fuzzing, which builds with debug assertions and overflow checks, and compile out of release builds, so production never panics. Input failures stay ordinary errors. https://github.com/marklauter/tsong/pull/51



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

Entrada de selo do projeto de propriedade de: Mark Lauter.
Entrada criada em 2026-11-19 03:54:59 UTC, última atualização em 2026-11-19 08:23:35 UTC. Selo de aprovação alcançado pela última vez em 2026-11-19 05:15:39 UTC.