Brazilian Utils

Los proyectos que siguen las mejores prácticas a continuación pueden autocertificarse voluntariamente y demostrar que han obtenido una insignia de mejores prácticas de Open Source Security Foundation (OpenSSF).

No existe un conjunto de prácticas que pueda garantizar que el software nunca tendrá defectos o vulnerabilidades; incluso los métodos formales pueden fallar si las especificaciones o suposiciones son incorrectas. Tampoco existe ningún conjunto de prácticas que pueda garantizar que un proyecto mantenga una comunidad de desarrollo saludable y que funcione bien. Sin embargo, seguir las mejores prácticas puede ayudar a mejorar los resultados de los proyectos. Por ejemplo, algunas prácticas permiten la revisión por parte de múltiples personas antes del lanzamiento, lo que puede ayudar a encontrar vulnerabilidades técnicas que de otro modo serían difíciles de encontrar y ayudar a generar confianza y un deseo repetido de interacción entre desarrolladores de diferentes compañías. Para obtener una insignia, se deben cumplir todos los criterios DEBE y NO DEBE, se deben cumplir, así como todos los criterios DEBERÍAN deben cumplirse o ser justificados, y todos los criterios SUGERIDOS se pueden cumplir o incumplir (queremos que se consideren al menos). Si desea añadir texto como justificación mediante un comentario genérico, en lugar de ser un razonamiento de que la situación es aceptable, comience el bloque de texto con '//' seguido de un espacio. Los comentarios son bienvenidos a través del sitio de GitHub mediante "issues" o "pull requests". También hay una lista de correo electrónico para el tema principal.

Con mucho gusto proporcionaríamos la información en varios idiomas, sin embargo, si hay algún conflicto o inconsistencia entre las traducciones, la versión en inglés es la versión autorizada.
Si este es su proyecto, por favor muestre el estado de su insignia base en la página de su proyecto. El estado de la insignia base se ve así: El nivel de insignia base para el proyecto 14695 es baseline-1 Aquí se explica cómo insertar la insignia base:
Puede mostrar el estado de su insignia base insertando esto en su archivo markdown:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/14695/baseline)](https://www.bestpractices.dev/projects/14695)
o insertando esto en su HTML:
<a href="https://www.bestpractices.dev/projects/14695"><img src="https://www.bestpractices.dev/projects/14695/baseline"></a>


Estos son los criterios de Nivel Base 1. Estos son los criterios de la versión v2026.08.28.

Baseline Series: Nivel Base 1 Nivel Base 2 Nivel Base 3

        

 Fundamentos

  • General

    Tenga en cuenta que otros proyectos pueden usar el mismo nombre.

    Utils library for specific Brazilian businesses

    Por favor use formato de expresión de licencia SPDX; los ejemplos incluyen "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT" y "(BSD-2-Clause OR Ruby)". No incluya comillas simples o comillas dobles.
    Si hay más de un lenguaje, enumérelos como valores separados por comas (los espacios son opcionales) y ordénelos de más a menos usado. Si hay una lista larga, por favor enumere al menos los tres primeros más comunes. Si no hay lenguaje (por ejemplo, este es un proyecto solo de documentación o solo de pruebas), use el carácter único "-". Por favor use una capitalización convencional para cada lenguaje, por ejemplo, "JavaScript".
    La Common Platform Enumeration (CPE) es un esquema de nomenclatura estructurado para sistemas de tecnología de la información, software y paquetes. Se utiliza en varios sistemas y bases de datos al reportar vulnerabilidades.

 Controles 24/24 ●

  • Controles


    ¡Suficiente para una insignia!

    Cuando un usuario intenta leer o modificar un recurso sensible en el repositorio autorizado del proyecto, el sistema DEBE requerir que el usuario complete un proceso de autenticación multifactor. [OSPS-AC-01.01]
    Aplique la autenticación multifactor para el sistema de control de versiones del proyecto, requiriendo que los colaboradores proporcionen una segunda forma de autenticación al acceder a datos sensibles o modificar la configuración del repositorio. Las claves de acceso (passkeys) son aceptables para este control.

    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.


    ¡Suficiente para una insignia!

    Cuando se agrega un nuevo colaborador, el sistema de control de versiones DEBE requerir asignación manual de permisos, o restringir los permisos del colaborador a los privilegios más bajos disponibles por defecto. [OSPS-AC-02.01]
    La mayoría de los sistemas de control de versiones públicos están configurados de esta manera. Asegúrese de que el sistema de control de versiones del proyecto siempre asigne los permisos más bajos disponibles a los colaboradores por defecto cuando se agreguen, otorgando permisos adicionales solo cuando sea necesario.

    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.


    ¡Suficiente para una insignia!

    Cuando se intenta un commit directo en la rama principal del proyecto, un mecanismo de aplicación DEBE evitar que se aplique el cambio. [OSPS-AC-03.01]
    Si el VCS está centralizado, establezca protección de rama en la rama principal en el VCS del proyecto. Alternativamente, use un enfoque descentralizado, como el del kernel de Linux, donde los cambios se proponen primero en otro repositorio, y fusionar cambios en el repositorio principal requiere un acto separado específico.

    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.


    ¡Suficiente para una insignia!

    Cuando se intenta eliminar la rama principal del proyecto, el sistema de control de versiones DEBE tratar esto como una actividad sensible y requerir confirmación explícita de la intención. [OSPS-AC-03.02]
    Establezca protección de rama en la rama principal en el sistema de control de versiones del proyecto para evitar la eliminación.

    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.


    ¡Suficiente para una insignia!

    Cuando un pipeline de CI/CD opera con metadatos no confiables, esos parámetros DEBEN sanearse y validarse antes de usarse en el pipeline. [OSPS-BR-01.01]
    Los flujos de CI/CD deben sanear (entre comillas, escapar o salir en valores esperados) todas las entradas de metadatos que correspondan a fuentes no confiables. Esto incluye datos como nombres de ramas, mensajes de confirmación, etiquetas, títulos de solicitudes de incorporación e información del autor.

    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.


    ¡Suficiente para una insignia!

    Cuando un flujo de CI/CD opera sobre instantáneas de código no confiable, DEBE impedir el acceso a credenciales y activos privilegiados de CI/CD. [OSPS-BR-01.03]
    Los flujos de CI/CD deben aislar las instantáneas de código no confiable de las credenciales y activos privilegiados. En particular, los proyectos deben tener cuidado de garantizar que los flujos de trabajo que compilan o ejecutan código antes de su revisión por un colaborador no tengan acceso a las credenciales de 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.


    ¡Suficiente para una insignia!

    Cuando el proyecto lista un URI como un canal oficial del proyecto, ese URI DEBE ser entregado exclusivamente usando canales cifrados. [OSPS-BR-03.01]
    Configure los sitios web y sistemas de control de versiones del proyecto para usar canales cifrados como SSH o HTTPS para la transmisión de datos. Asegúrese de que todas las herramientas y dominios referenciados en la documentación del proyecto solo puedan accederse a través de canales cifrados.

    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.


    ¡Suficiente para una insignia!

    Cuando el proyecto indique una URI como canal de distribución oficial, ese canal DEBE estar protegido contra ataques de adversario en el medio (adversary-in-the-middle) mediante canales criptográficamente autenticados. [OSPS-BR-03.02]
    Los artefactos distribuidos por el proyecto deben distribuirse a través de canales que garanticen la integridad y la autenticidad. El uso de HTTPS para las descargas, versiones firmadas o distribución a través de gestores de paquetes confiables son métodos aceptables para proteger contra ataques de adversario en el medio.

    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.


    ¡Suficiente para una insignia!

    El proyecto DEBE prevenir el almacenamiento no intencionado de datos sensibles no cifrados, como secretos y credenciales, en el sistema de control de versiones. [OSPS-BR-07.01]
    Configure .gitignore o equivalente para excluir archivos que puedan contener información sensible. Use hooks de pre-commit y herramientas de escaneo automatizado para detectar y prevenir la inclusión de datos sensibles en los 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.


    ¡Suficiente para una insignia!

    Cuando el proyecto haya realizado un lanzamiento, la documentación del proyecto DEBE incluir guías de usuario para toda la funcionalidad básica. [OSPS-DO-01.01]
    Cree guías de usuario o documentación para toda la funcionalidad básica del proyecto, explicando cómo instalar, configurar y usar las características del proyecto. Si hay acciones peligrosas o destructivas disponibles, incluya advertencias altamente 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


    ¡Suficiente para una insignia!

    Cuando el proyecto haya realizado un lanzamiento, la documentación del proyecto DEBE incluir una guía para reportar defectos. [OSPS-DO-02.01]
    Se recomienda que los proyectos utilicen el gestor de incidencias predeterminado de su VCS. Si se utiliza una fuente externa, asegúrese de que la documentación del proyecto y la guía de contribución expliquen claramente y de manera visible cómo usar el sistema de reporte. Se recomienda que la documentación del proyecto también establezca expectativas sobre cómo se clasificarán y resolverán los defectos.

    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.


    ¡Suficiente para una insignia!

    El proyecto DEBE contar con uno o más mecanismos para realizar discusiones públicas sobre los cambios propuestos y los obstáculos de uso. [OSPS-GV-02.01]
    Establezca uno o más mecanismos para discusiones públicas dentro del proyecto, como listas de correo, mensajería instantánea o gestores de incidencias, para facilitar la comunicación abierta y la retroalimentación.

    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.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir una explicación del proceso de contribución, o indicar claramente que no se aceptan contribuciones públicas [OSPS-GV-03.01]
    Cree un archivo CONTRIBUTING.md o un directorio CONTRIBUTING/ para delinear el proceso de contribución, incluyendo los pasos para enviar cambios e interactuar con los mantenedores del proyecto.

    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.


    ¡Suficiente para una insignia!

    La licencia del código fuente DEBE cumplir con la Definición de Código Abierto de la OSI o la Definición de Software Libre de la FSF. [OSPS-LE-02.01]
    Agregue un archivo LICENSE al repositorio del proyecto con una licencia que sea una licencia aprobada por la Open Source Initiative (OSI), o una licencia libre aprobada por la Free Software Foundation (FSF). Ejemplos de tales licencias incluyen MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), y la GNU General Public License (GPL). Liberar al dominio público cumple con este control si no hay otros gravámenes como patentes.

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


    ¡Suficiente para una insignia!

    La licencia de los activos de software publicados DEBE cumplir con la Definición de Código Abierto de la OSI o la Definición de Software Libre de la FSF. [OSPS-LE-02.02]
    Si se incluye una licencia diferente con los activos de software lanzados, asegúrese de que sea una licencia aprobada por la Open Source Initiative (OSI), o una licencia libre aprobada por la Free Software Foundation (FSF). Ejemplos de tales licencias incluyen MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), y la GNU General Public License (GPL). Tenga en cuenta que la licencia para los activos de software lanzados puede ser diferente a la del código fuente.

    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.


    ¡Suficiente para una insignia!

    La licencia del código fuente DEBE mantenerse en el archivo LICENSE, el archivo COPYING, el directorio LICENSES/ o el directorio LICENSE/ del repositorio correspondiente. [OSPS-LE-03.01]
    Incluya la licencia del código fuente del proyecto en el archivo LICENSE, el archivo COPYING, el directorio LICENSES/ o el directorio LICENSE/ del proyecto para proporcionar visibilidad y claridad sobre los términos de la licencia. El nombre del archivo PUEDE tener una extensión. Si el proyecto tiene varios repositorios, asegúrese de que cada repositorio incluya el archivo de licencia.

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


    ¡Suficiente para una insignia!

    La licencia de los activos de software publicados DEBE incluirse en el código fuente publicado, o en un archivo LICENSE, un archivo COPYING o un directorio LICENSE/ junto a los activos de la versión correspondiente. [OSPS-LE-03.02]
    Incluya la licencia de los activos de software lanzados del proyecto en el código fuente lanzado, o en un archivo LICENSE, archivo COPYING o directorio LICENSE/ junto con los activos de lanzamiento correspondientes para proporcionar visibilidad y claridad sobre los términos de licencia. El nombre de archivo PUEDE tener una extensión. Si el proyecto tiene múltiples repositorios, asegúrese de que cada repositorio incluya el archivo de licencia.

    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.


    ¡Suficiente para una insignia!

    El repositorio de código fuente del proyecto DEBE ser legible públicamente en una URL estática. [OSPS-QA-01.01]
    Use un VCS común como GitHub, GitLab o Bitbucket. Asegúrese de que el repositorio sea legible públicamente. Evite la duplicación o creación de mirrors de repositorios a menos que la documentación altamente visible aclare la fuente principal. Evite cambios frecuentes en el repositorio que impactarían la URL del repositorio. Asegúrese de que el repositorio sea público.

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


    ¡Suficiente para una insignia!

    El sistema de control de versiones DEBE contener un registro legible públicamente de todos los cambios realizados, quién los realizó y cuándo se realizaron los cambios. [OSPS-QA-01.02]
    Use un VCS común como GitHub, GitLab o Bitbucket para mantener un historial de commits legible públicamente. Evite aplastar o reescribir commits de una manera que oscurecería al autor de cualquier 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).


    ¡Suficiente para una insignia!

    Cuando el sistema de gestión de paquetes lo admita, el repositorio de código fuente DEBE contener una lista de dependencias que contabilice las dependencias directas del lenguaje. [OSPS-QA-02.01]
    Esto puede tomar la forma de un gestor de paquetes o un archivo de dependencias del lenguaje que enumere todas las dependencias directas como package.json, Gemfile o 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.


    ¡Suficiente para una insignia!

    Los proyectos con múltiples repositorios DEBEN documentar una lista de bases de código que forman parte del proyecto. [OSPS-QA-04.01]
    Documente cualquier repositorio de código de subproyecto adicional producido por el proyecto y compilado en un lanzamiento. Esta documentación debe incluir el estado e intención de la respectiva base de código.

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


    ¡Suficiente para una insignia!

    El sistema de control de versiones NO DEBE contener artefactos ejecutables generados. [OSPS-QA-05.01]
    Elimine los artefactos ejecutables generados en el sistema de control de versiones del proyecto. Se recomienda que cualquier escenario donde un artefacto ejecutable generado parezca crítico para un proceso como las pruebas, en su lugar debería generarse en el momento de la compilación o almacenarse por separado y obtenerse durante un paso de pipeline específico y bien documentado.

    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.


    ¡Suficiente para una insignia!

    El sistema de control de versiones NO DEBE contener artefactos binarios que no se puedan revisar. [OSPS-QA-05.02]
    No agregue ningún artefacto binario no revisable al sistema de control de versiones del proyecto. Esto incluye binarios de aplicaciones ejecutables, archivos de biblioteca y artefactos similares. No incluye activos como imágenes gráficas, archivos de sonido o música y contenido similar que típicamente se almacena en formato binario.

    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.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE contener los contactos de seguridad. [OSPS-VM-02.01]
    Cree un archivo security.md (o con nombre similar) que contenga contactos de seguridad para el proyecto.

    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.



Puede utilizar herramientas y sistemas de IA para proponer cambios a través de una URL simple, como https://www.bestpractices.dev/es/projects/14695/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. Consulte nuestro sistema de propuestas de automatización para saber cómo hacerlo. Estos datos están disponibles bajo el Acuerdo de Licencia de Datos de la Comunidad – Permisivo, Versión 2.0 (CDLA-Permissive-2.0). Esto significa que un Destinatario de Datos puede compartir los Datos, con o sin modificaciones, siempre que el Destinatario de Datos ponga a disposición el texto de este acuerdo con los Datos compartidos. Por favor, acredite a Hyan Mandian y a los colaboradores de la insignia de Mejores Prácticas de OpenSSF.

Entrada de insignia del proyecto propiedad de: Hyan Mandian.
Entrada creada el 2026-09-18 03:05:32 UTC, última actualización el 2026-09-18 20:25:27 UTC. Última obtención de la insignia de nivel básico el 2026-09-18 20:24:24 UTC.