Brazilian Utils

Les projets qui suivent les meilleures pratiques ci-dessous peuvent s'auto-certifier et montrer qu'ils ont obtenu le badge de la Open Source Security Foundation (OpenSSF).

Il n'existe aucun ensemble de pratiques qui garantissent que ce logiciel n'aura jamais de défauts ou de vulnérabilités ; même les méthodes formelles peuvent échouer si les spécifications ou les hypothèses sont fausses. Il n'y a pas non plus de pratiques qui peuvent garantir qu'un projet permettra de maintenir une communauté de développement saine et qui fonctionne bien. Toutefois, suivre les meilleures pratiques peut contribuer à améliorer les résultats des projets. Par exemple, certaines pratiques permettent la revue par plusieurs personnes avant publication, ce qui peut aider à trouver des vulnérabilités techniques difficiles à trouver autrement et à renforcer la confiance et un désir d'interaction répétée entre les développeurs de différentes entreprises. Pour gagner un badge, tous les critères DOIT et NE DOIT PAS doivent être satisfaits, tous les critères DEVRAIT doivent être satisfaits OU non satisfaits avec justification, et tous les critères PROPOSÉ doivent être satisfaits OU non satisfaits (nous voulons au moins qu'ils soient considérés). Si vous voulez entrer un texte de justification pour un commentaire générique, au lieu d'une raison justifiant que la situation est acceptable, commencez le bloc de texte avec '//' suivi d'un espace. Les commentaires sont les bienvenus via le site GitHub en tant que problèmes ou pull requests. Il existe également une liste de diffusion pour discussion générale.

Nous fournissons volontiers l'information dans plusieurs langues, cependant, s'il existe un conflit ou une contradiction entre les traductions, la version anglaise est la version qui fait autorité.
Si c'est votre projet, veuillez afficher votre statut de badge de référence sur la page de votre projet ! Le statut du badge de référence ressemble à ceci : Le niveau du badge de référence pour le projet 14695 est baseline-1 Voici comment intégrer le badge de référence :
Vous pouvez afficher votre statut de badge de référence en incorporant ceci dans votre fichier markdown :
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/14695/baseline)](https://www.bestpractices.dev/projects/14695)
ou en incorporant ceci dans votre HTML :
<a href="https://www.bestpractices.dev/projects/14695"><img src="https://www.bestpractices.dev/projects/14695/baseline"></a>


Voici les critères du niveau de référence 1. Il s'agit des critères version v2026.08.28.

Baseline Series: Niveau de référence 1 Niveau de référence 2 Niveau de référence 3

        

 Notions de base

  • Général

    Notez que d'autres projets peuvent utiliser le même nom.

    Utils library for specific Brazilian businesses

    Utilisez un format d'expression de licence SPDX ; des exemples sont « Apache-2.0 », « BSD-2-Clause », « BSD-3-Clause », « GPL-2.0+ », « LGPL-3.0+ », « MIT » et « (BSD-2-Clause OU Ruby) ». Ne pas inclure des guillemets simples ou doubles.
    S'il y a plus d'un langage, listez-les en tant que valeurs séparées par des virgules (espaces facultatifs) et triez-les du plus au moins utilisé. S'il y a une longue liste, veuillez lister au moins les trois premiers. S'il n'y a pas de langage (par exemple, il s'agit d'un projet uniquement de documentation ou de test), utilisez le caractère unique « - ». Utilisez une capitalisation conventionnelle pour chaque langage, par exemple « JavaScript ».
    La plate-forme commune d'énumération (CPE) est un schéma de dénomination structuré pour les systèmes, les logiciels et les paquetages des technologies de l'information. Il est utilisé dans un certain nombre de systèmes et de bases de données pour signaler des vulnérabilités.

 Contrôles 24/24 ●

  • Contrôles


    Assez pour un badge !

    Lorsqu'un utilisateur tente de lire ou de modifier une ressource sensible dans le dépôt faisant autorité du projet, le système DOIT exiger que l'utilisateur termine un processus d'authentification multi-facteurs. [OSPS-AC-01.01]
    Imposer l'authentification multi-facteurs pour le système de contrôle de version du projet, exigeant des collaborateurs qu'ils fournissent une seconde forme d'authentification lors de l'accès aux données sensibles ou de la modification des paramètres du dépôt. Les passkeys sont acceptables pour ce contrôle.

    The brazilian-utils GitHub organization enforces two-factor authentication for every member (Organization settings → Authentication security → "Require two-factor authentication"), so nobody can change repository settings or access sensitive data without MFA.


    Assez pour un badge !

    Lorsqu'un nouveau collaborateur est ajouté, le système de contrôle de version DOIT exiger une attribution manuelle de permissions, ou restreindre les permissions du collaborateur aux privilèges disponibles les plus bas par défaut. [OSPS-AC-02.01]
    La plupart des systèmes de contrôle de version publics sont configurés de cette manière. Assurez-vous que le système de contrôle de version du projet attribue toujours les permissions les plus basses disponibles aux collaborateurs par défaut lorsqu'ils sont ajoutés, accordant des permissions supplémentaires uniquement lorsque cela est nécessaire.

    New organization members and collaborators receive GitHub's read-only base permission by default. Write access exists only for the sole maintainer listed in https://github.com/brazilian-utils/javascript/blob/main/.github/CODEOWNERS; every other contribution arrives through a fork and a pull request.


    Assez pour un badge !

    Lorsqu'un commit direct est tenté sur la branche principale du projet, un mécanisme d'application DOIT empêcher la modification d'être appliquée. [OSPS-AC-03.01]
    Si le VCS est centralisé, définissez une protection de branche sur la branche principale dans le VCS du projet. Alternativement, utilisez une approche décentralisée, comme celle du noyau Linux, où les modifications sont d'abord proposées dans un autre dépôt, et la fusion des modifications dans le dépôt principal nécessite un acte distinct spécifique.

    main is a protected branch: changes must come through a pull request, a review from the code owners (.github/CODEOWNERS) is required and the Check, Tests, Build, Mutation tests and Security workflows must pass before merging. Direct pushes are rejected for everyone except an explicit administrator bypass.


    Assez pour un badge !

    Lorsqu'une tentative est faite de supprimer la branche principale du projet, le système de contrôle de version DOIT traiter cela comme une activité sensible et exiger une confirmation explicite de l'intention. [OSPS-AC-03.02]
    Définissez une protection de branche sur la branche principale dans le système de contrôle de version du projet pour empêcher la suppression.

    main is a protected branch and GitHub branch protection keeps "Allow deletions" off, so the primary branch cannot be deleted through git or the web UI.


    Assez pour un badge !

    Lorsqu'un pipeline CI/CD fonctionne sur des métadonnées non fiables, ces paramètres DOIVENT être nettoyés et validés avant d'être utilisés dans le pipeline. [OSPS-BR-01.01]
    Les pipelines CI/CD doivent assainir (mettre entre guillemets, échapper ou quitter pour les valeurs attendues) toutes les entrées de métadonnées correspondant à des sources non fiables. Cela inclut des données telles que les noms de branches, les messages de commit, les tags, les titres des pull requests et les informations sur l'auteur.

    No workflow interpolates untrusted event data (pull request titles or bodies, branch names, issue text, commit messages) into a shell step: the only expressions used inside run: steps are a commit SHA (github.event.pull_request.base.sha) and a value from the workflow's own matrix. Workflows take no workflow_dispatch inputs. zizmor runs on every pull request at min-severity: low (.github/workflows/security.yml) and fails the build on its template-injection audit, so an unsanitized expression cannot be merged.


    Assez pour un badge !

    Lorsqu'un pipeline CI/CD opère sur des instantanés de code non fiables, il DOIT empêcher l'accès aux identifiants et aux ressources privilégiés du CI/CD. [OSPS-BR-01.03]
    Les pipelines CI/CD doivent isoler les instantanés de code non fiables des identifiants et des ressources privilégiés. En particulier, les projets doivent veiller à ce que les workflows qui compilent ou exécutent du code avant examen par un collaborateur n'aient pas accès aux identifiants CI/CD.

    Pull requests are built with the pull_request event only (never pull_request_target), so a fork's code runs with a read-only GITHUB_TOKEN (top-level permissions: contents: read in every workflow) and, by GitHub's design, without access to repository secrets; checkouts use persist-credentials: false. Publishing to npm happens only in the publish job of the Release workflow, on a tag created by release-please on main, through OIDC Trusted Publishing bound to the npm environment; no long-lived publish token exists. GitHub Actions requires a maintainer's approval before workflows run for outside contributors.


    Assez pour un badge !

    Lorsque le projet liste un URI comme canal officiel du projet, cet URI DOIT être exclusivement fourni en utilisant des canaux chiffrés. [OSPS-BR-03.01]
    Configurez les sites Web et les systèmes de contrôle de version du projet pour utiliser des canaux chiffrés tels que SSH ou HTTPS pour la transmission de données. Assurez-vous que tous les outils et domaines référencés dans la documentation du projet ne peuvent être accessibles que via des canaux chiffrés.

    The repository (https://github.com/brazilian-utils/javascript), the documentation site (https://brazilian-utils.com.br, GitHub Pages with HTTPS enforced) and the npm registry are all served over HTTPS only.


    Assez pour un badge !

    Lorsque le projet répertorie une URI comme canal de distribution officiel, ce canal DOIT être protégé contre les attaques de l'adversaire au milieu (adversary-in-the-middle) à l'aide de canaux authentifiés cryptographiquement. [OSPS-BR-03.02]
    Les artefacts distribués par le projet devraient être distribués par des canaux qui garantissent l'intégrité et l'authenticité. L'utilisation de HTTPS pour les téléchargements, de versions signées ou de la distribution via des gestionnaires de paquets fiables sont toutes des méthodes acceptables pour se protéger contre les attaques de l'adversaire au milieu.

    The package is distributed through the npm registry (https://registry.npmjs.org) and GitHub Releases, both HTTPS-only. Publishing uses npm Trusted Publishing (OIDC) with --provenance, so every version carries a Sigstore provenance attestation.


    Assez pour un badge !

    Le projet DOIT empêcher le stockage involontaire de données sensibles non chiffrées, telles que des secrets et des informations d'identification, dans le système de contrôle de version. [OSPS-BR-07.01]
    Configurez .gitignore ou équivalent pour exclure les fichiers susceptibles de contenir des informations sensibles. Utilisez des hooks de pré-commit et des outils d'analyse automatisés pour détecter et empêcher l'inclusion de données sensibles dans les commits.

    Two independent controls. GitHub secret scanning with push protection is enabled, so a push containing a known credential pattern is rejected before it reaches the repository and the history is covered by alerts. The Security workflow (.github/workflows/security.yml, job "Scan for committed secrets") also runs TruffleHog on the commits of every pull request and push, and on the whole history weekly, failing on verified or unverifiable findings. The project keeps no credentials in the tree by design: npm publishing uses Trusted Publishing (OIDC), the only two secrets (Codecov and Stryker dashboard tokens) live in GitHub Actions encrypted secrets, checkouts run with persist-credentials: false, .gitignore excludes .env files, and zizmor lints every workflow for hard-coded credentials.


    Assez pour un badge !

    Lorsque le projet a effectué une publication, la documentation du projet DOIT inclure des guides utilisateur pour toutes les fonctionnalités de base. [OSPS-DO-01.01]
    Créez des guides utilisateur ou de la documentation pour toutes les fonctionnalités de base du projet, en expliquant comment installer, configurer et utiliser les fonctionnalités du projet. S'il existe des actions dangereuses ou destructrices connues disponibles, incluez des avertissements très visibles.

    https://brazilian-utils.com.br has a Getting Started guide, a reference of every utility with parameters, return values and examples (docs/utilities.md, also in Portuguese at docs/pt-br/utilities.md), a v1 → v2 migration guide and runtime-support notes; the README covers installation and basic usage


    Assez pour un badge !

    Lorsque le projet a effectué une publication, la documentation du projet DOIT inclure un guide pour signaler les défauts. [OSPS-DO-02.01]
    Il est recommandé que les projets utilisent le suivi de problèmes par défaut de leur VCS. Si une source externe est utilisée, assurez-vous que la documentation du projet et le guide de contribution expliquent clairement et visiblement comment utiliser le système de signalement. Il est recommandé que la documentation du projet établisse également des attentes quant à la manière dont les défauts seront triés et résolus.

    SUPPORT.md explains where to report bugs and ask questions, and the repository ships issue forms for bug reports and feature requests (.github/ISSUE_TEMPLATE/bug_report.yml, feature_request.yml): https://github.com/brazilian-utils/javascript/issues/new/choose. Security defects go through SECURITY.md instead.


    Assez pour un badge !

    Le projet DOIT disposer d'un ou plusieurs mécanismes pour les discussions publiques concernant les changements proposés et les obstacles à l'utilisation. [OSPS-GV-02.01]
    Établissez un ou plusieurs mécanismes pour des discussions publiques au sein du projet, tels que des listes de diffusion, de la messagerie instantanée ou des systèmes de suivi de problèmes, pour faciliter une communication et des retours ouverts.

    GitHub Discussions (https://github.com/brazilian-utils/javascript/discussions) is the public channel for questions and proposals, and GitHub Issues and pull requests hold the discussion of concrete changes; SUPPORT.md points users to both.


    Assez pour un badge !

    La documentation du projet DOIT inclure une explication du processus de contribution, ou indiquer clairement que les contributions publiques ne sont pas acceptées [OSPS-GV-03.01]
    Créez un fichier CONTRIBUTING.md ou un répertoire CONTRIBUTING/ pour décrire le processus de contribution, y compris les étapes pour soumettre des modifications et interagir avec les mainteneurs du projet.

    CONTRIBUTING.md (https://github.com/brazilian-utils/javascript/blob/main/CONTRIBUTING.md) documents setup, how to add a utility, the lint/type/test/mutation gates, commit-message conventions and the pull-request process, and the pull request template carries the checklist.


    Assez pour un badge !

    La licence du code source DOIT satisfaire à l'Open Source Definition de l'OSI ou à la Free Software Definition de la FSF. [OSPS-LE-02.01]
    Ajoutez un fichier LICENSE au dépôt du projet avec une licence qui est une licence approuvée par l'Open Source Initiative (OSI), ou une licence libre approuvée par la Free Software Foundation (FSF). Des exemples de telles licences incluent MIT, BSD 2-clause, BSD 3-clause révisée, Apache 2.0, Lesser GNU General Public License (LGPL) et GNU General Public License (GPL). Publier dans le domaine public répond à ce contrôle s'il n'y a pas d'autres restrictions telles que des brevets.

    The source code is licensed under the MIT License (OSI-approved, FSF-free): https://github.com/brazilian-utils/javascript/blob/main/LICENSE.


    Assez pour un badge !

    La licence des ressources logicielles publiées DOIT satisfaire à l'Open Source Definition de l'OSI ou à la Free Software Definition de la FSF. [OSPS-LE-02.02]
    Si une licence différente est incluse avec les ressources logicielles publiées, assurez-vous qu'il s'agit d'une licence approuvée par l'Open Source Initiative (OSI), ou d'une licence libre approuvée par la Free Software Foundation (FSF). Des exemples de telles licenses incluent MIT, BSD 2-clause, BSD 3-clause révisée, Apache 2.0, Lesser GNU General Public License (LGPL) et GNU General Public License (GPL). Notez que la licence des ressources logicielles publiées peut être différente de celle du code source.

    The released package is under the same MIT License: package.json declares "license": "MIT" and the npm registry shows it for every version of @brazilian-utils/brazilian-utils.


    Assez pour un badge !

    La licence du code source DOIT être conservée dans le fichier LICENSE, le fichier COPYING, le répertoire LICENSES/ ou le répertoire LICENSE/ du dépôt correspondant. [OSPS-LE-03.01]
    Incluez la licence du code source du projet dans le fichier LICENSE, le fichier COPYING, le répertoire LICENSES/ ou le répertoire LICENSE/ du projet afin de fournir de la visibilité et de la clarté sur les conditions de licence. Le nom de fichier PEUT avoir une extension. Si le projet dispose de plusieurs dépôts, assurez-vous que chaque dépôt inclut le fichier de licence.

    The full text is in /LICENSE at the repository root.


    Assez pour un badge !

    La licence des ressources logicielles publiées DOIT être incluse dans le code source publié, ou dans un fichier LICENSE, un fichier COPYING, ou un répertoire LICENSE/ accompagnant les ressources de la version correspondante. [OSPS-LE-03.02]
    Incluez la licence des ressources logicielles publiées du projet dans le code source publié, ou dans un fichier LICENSE, un fichier COPYING ou un répertoire LICENSE/ aux côtés des ressources de publication correspondantes pour fournir visibilité et clarté sur les termes de la licence. Le nom de fichier PEUT avoir une extension. Si le projet a plusieurs dépôts, assurez-vous que chaque dépôt inclut le fichier de licence.

    npm always includes the LICENSE file in the published tarball (it is one of the files npm ships regardless of the files field), so every version on the registry carries it; the GitHub Release source archives contain it as well.


    Assez pour un badge !

    Le dépôt de code source du projet DOIT être lisible publiquement à une URL statique. [OSPS-QA-01.01]
    Utilisez un VCS commun tel que GitHub, GitLab ou Bitbucket. Assurez-vous que le référentiel est publiquement lisible. Évitez la duplication ou la mise en miroir de référentiels à moins qu'une documentation très visible ne clarifie la source principale. Évitez les changements fréquents du référentiel qui affecteraient l'URL du référentiel. Assurez-vous que le référentiel est public.

    https://github.com/brazilian-utils/javascript is a public repository.


    Assez pour un badge !

    Le système de contrôle de version DOIT contenir un enregistrement publiquement lisible de toutes les modifications apportées, qui les a apportées et quand elles ont été apportées. [OSPS-QA-01.02]
    Utilisez un VCS commun tel que GitHub, GitLab ou Bitbucket pour maintenir un historique de commits publiquement lisible. Évitez de fusionner ou de réécrire les commits d'une manière qui obscurcirait l'auteur de tout commit.

    The full git history, with author, committer and dates of every change, is public on GitHub: https://github.com/brazilian-utils/javascript/commits/main (plus diffs, blame and pull-request history).


    Assez pour un badge !

    Lorsque le système de gestion de paquets le prend en charge, le référentiel de code source DOIT contenir une liste de dépendances qui tient compte des dépendances directes du langage. [OSPS-QA-02.01]
    Cela peut prendre la forme d'un fichier de gestionnaire de paquets ou de dépendances de langage qui énumère toutes les dépendances directes telles que package.json, Gemfile ou go.mod.

    package.json lists the direct dependencies (there are no runtime dependencies, only devDependencies) and package-lock.json (lockfileVersion 3) pins every direct and transitive one. Every release run also produces a CycloneDX SBOM (npm sbom) kept as the sbom-<tag> artifact of the release workflow.


    Assez pour un badge !

    Les projets comportant plusieurs dépôts DOIVENT documenter une liste des bases de code qui font partie du projet. [OSPS-QA-04.01]
    Documentez tous les référentiels de code de sous-projets supplémentaires produits par le projet et compilés dans une version. Cette documentation doit inclure l'état et l'intention du code source respectif.

    The repository is a single npm package; it has no git submodules, vendored code or subproject codebases.


    Assez pour un badge !

    Le système de contrôle de version NE DOIT PAS contenir d'artefacts exécutables générés. [OSPS-QA-05.01]
    Supprimez les artefacts exécutables générés dans le système de contrôle de version du projet. Il est recommandé que tout scénario où un artefact exécutable généré apparaît critique pour un processus tel que les tests, il devrait plutôt être généré au moment de la compilation ou stocké séparément et récupéré lors d'une étape de pipeline spécifique bien documentée.

    The repository contains only source: dist/ is built in CI and is git-ignored, and there are no binaries, bundles or other generated executables committed.


    Assez pour un badge !

    Le système de contrôle de version NE DOIT PAS contenir d'artefacts binaires non révisables. [OSPS-QA-05.02]
    N'ajoutez aucun artefact binaire non révisable au système de contrôle de version du projet. Cela inclut les binaires d'applications exécutables, les fichiers de bibliothèque et les artefacts similaires. Cela n'inclut pas les ressources telles que les images graphiques, les fichiers sonores ou musicaux et le contenu similaire généralement stocké dans un format binaire.

    The repository contains only reviewable text: TypeScript sources and tests, Markdown docs, YAML workflows, JSON configuration and the generated llms*.txt. There are no images, fonts, archives, compiled bundles or other binary files tracked in git (the documentation site loads its logo and favicons from the separate brazilian-utils/brand repository by URL); dist/ is built in CI and git-ignored; the datasets in src/_internals/constants/ are TypeScript tables regenerated from their official sources by scripts/, so every change to them shows up as a reviewable diff in a pull request. OpenSSF Scorecard's Binary-Artifacts check, run on every push to main and weekly, reports no findings.


    Assez pour un badge !

    La documentation du projet DOIT contenir des contacts de sécurité. [OSPS-VM-02.01]
    Créez un fichier security.md (ou portant un nom similaire) qui contient les contacts de sécurité pour le projet.

    SECURITY.md (https://github.com/brazilian-utils/javascript/blob/main/SECURITY.md) asks for private reports through GitHub Private Vulnerability Reporting (Security tab → "Report a vulnerability") or by e-mail to support@brazilian-utils.com.br, lists what to include and what is in scope.



Vous pouvez utiliser des outils et des systèmes d'IA pour proposer des modifications via une URL simple, par exemple https://www.bestpractices.dev/fr/projects/14695/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. Consultez notre système de propositions d'automatisation pour savoir comment procéder. Ces données sont disponibles sous la licence Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). Cela signifie qu'un destinataire de données peut partager les données, avec ou sans modifications, à condition que le destinataire de données rende disponible le texte de cet accord avec les données partagées. Veuillez créditer Hyan Mandian et les contributeurs du badge des meilleures pratiques de la OpenSSF.

Soumission du badge du projet appartenant à : Hyan Mandian.
Soumission créée le 2026-09-18 03:05:32 UTC, dernière mise à jour le 2026-09-18 20:25:27 UTC. Le dernier badge obtenu l'a été le 2026-09-18 20:24:24 UTC.