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 2. 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 18/19 ●

  • Controles


    ¡Suficiente para una insignia!

    Cuando una tarea de CI/CD se ejecuta sin permisos especificados, el sistema de CI/CD DEBE establecer por defecto los permisos de la tarea a los permisos más bajos otorgados en el pipeline. [OSPS-AC-04.01]
    Configure las configuraciones del proyecto para asignar los permisos más bajos disponibles a nuevos pipelines por defecto, otorgando permisos adicionales solo cuando sea necesario para tareas específicas.

    Every workflow declares a top-level permissions: contents: read, so any job that does not state its own permissions runs read-only; the few jobs that need more (release-please, the dataset PR job, the Scorecard upload) escalate at job level only. zizmor's excessive-permissions audit runs on every pull request and fails the build if a workflow drops this.


    ¡Suficiente para una insignia!

    Cuando se crea un lanzamiento oficial, ese lanzamiento DEBE ser asignado un identificador de versión único. [OSPS-BR-02.01]
    Asigne un identificador de versión único a cada lanzamiento producido por el proyecto, siguiendo una convención de nomenclatura o esquema de numeración consistente. Los ejemplos incluyen SemVer, CalVer o ID de commit de git.

    Releases follow Semantic Versioning and are cut by release-please: each one gets a git tag (e.g. v2.4.0), a GitHub Release and the matching version on npm (https://www.npmjs.com/package/@brazilian-utils/brazilian-utils?activeTab=versions). CHANGELOG.md records every version.


    ¡Suficiente para una insignia!

    Cuando se crea un lanzamiento oficial, ese lanzamiento DEBE contener un registro descriptivo de modificaciones funcionales y de seguridad. [OSPS-BR-04.01]
    Asegúrese de que todos los lanzamientos incluyan un registro de cambios descriptivo. Se recomienda asegurar que el registro de cambios sea legible por humanos e incluya detalles más allá de los mensajes de commit, como descripciones del impacto de seguridad o relevancia para diferentes casos de uso. Para asegurar la legibilidad automática, coloque el contenido bajo un encabezado markdown como "## Changelog".

    CHANGELOG.md is generated by release-please from the Conventional Commits history and the same text becomes the GitHub Release notes; security fixes appear as fix: entries and any advisory is linked from the release.


    ¡Suficiente para una insignia!

    Cuando un pipeline de construcción y lanzamiento ingiere dependencias, DEBE usar herramientas estandarizadas donde estén disponibles. [OSPS-BR-05.01]
    Use herramientas comunes para su ecosistema, como gestores de paquetes o herramientas de gestión de dependencias para ingerir dependencias en tiempo de construcción. Esto puede incluir usar un archivo de dependencias, archivo de bloqueo o manifiesto para especificar las dependencias requeridas, que luego son incorporadas por el sistema de construcción.

    CI and the release job install with npm ci from package-lock.json; every GitHub Action is pinned to a full commit SHA and updated by Dependabot (.github/dependabot.yml); the release is built and published only by the workflow.


    ¡Suficiente para una insignia!

    Cuando se crea un lanzamiento oficial, ese lanzamiento DEBE estar firmado o registrado en un manifiesto firmado que incluya los hashes criptográficos de cada activo. [OSPS-BR-06.01]
    Firme todos los activos de software lanzados en tiempo de construcción con una firma criptográfica o atestaciones, como firma GPG o PGP, firmas Sigstore, proveniencia SLSA, o VSAs SLSA. Incluya los hashes criptográficos de cada activo en un manifiesto firmado o archivo de metadatos.

    Every version is published with npm provenance: a Sigstore attestation signed by the release workflow's OIDC identity that covers the package tarball and its sha512 integrity hash, recorded in the public transparency log, plus the registry's own signature. Consumers verify both with npm audit signatures; the attestation is shown on the version's Provenance panel on npmjs.com.


    ¡Suficiente para una insignia!

    Cuando el proyecto ha realizado un lanzamiento, la documentación del proyecto DEBE incluir una descripción de cómo el proyecto selecciona, obtiene y rastrea sus dependencias. [OSPS-DO-06.01]
    Se recomienda publicar esta información junto con la documentación técnica y de diseño del proyecto en un recurso públicamente visible como el repositorio de código fuente, sitio web del proyecto u otro canal.

    CONTRIBUTING.md "Zero runtime dependencies" and "Supply chain" describe the no-runtime-dependency rule, npm ci from the lockfile, SHA-pinned actions, weekly Dependabot updates, OSV-Scanner, audit-ci and lockfile-lint.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir instrucciones sobre cómo compilar el software, incluyendo las bibliotecas, marcos, SDK y dependencias necesarias. [OSPS-DO-07.01]
    Se recomienda publicar esta información junto con la documentación para colaboradores del proyecto, por ejemplo en CONTRIBUTING.md u otra documentación de tareas para desarrolladores. También puede documentarse utilizando objetivos de Makefile u otros scripts de automatización.

    README "Development" and CONTRIBUTING.md "Getting started" document the requirements (Node.js 24 per .nvmrc, npm) and the commands (npm install, npm run check, npm test, npm run build); the toolchain (Vite+) is a dev dependency, nothing global is needed.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir una lista de los miembros del proyecto que tienen acceso a recursos sensibles. [OSPS-GV-01.01]
    Documente los participantes del proyecto y sus roles a través de artefactos tales como members.md, governance.md, maintainers.md, o archivo similar dentro del repositorio de código fuente del proyecto. Esto puede ser tan simple como incluir nombres o identificadores de cuenta en una lista de mantenedores, o más complejo dependiendo de la gobernanza del proyecto.

    MAINTAINERS.md (https://github.com/brazilian-utils/javascript/blob/main/MAINTAINERS.md) lists the maintainers, the only accounts with write/admin access to the repository and publish rights on npm; .github/CODEOWNERS mirrors it.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir descripciones de los roles y responsabilidades de los miembros del proyecto [OSPS-GV-01.02]
    Documente los participantes del proyecto y sus roles a través de artefactos tales como members.md, governance.md, maintainers.md, o archivo similar dentro del repositorio de código fuente del proyecto.

    MAINTAINERS.md "Roles" defines the contributor, maintainer and automation roles and what each one does (review, merge, release approval on npm with 2FA, triage of security reports, datasets and toolchain upkeep); CONTRIBUTING.md "Governance" points to it.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir una guía para colaboradores de código que incluya los requisitos para que las contribuciones sean aceptables. [OSPS-GV-03.02]
    Extienda el CONTRIBUTING.md o los contenidos de CONTRIBUTING/ en la documentación del proyecto para delinear los requisitos para contribuciones aceptables, incluyendo estándares de codificación, requisitos de pruebas y pautas de envío para contribuidores de código. Se recomienda que esta guía sea la fuente de verdad tanto para contribuidores como para aprobadores.

    CONTRIBUTING.md requires tests for new behaviour, passing lint/type/coverage/duplication/unused-code/mutation gates, Conventional Commit messages, docs in both languages, no runtime dependencies, no unagreed breaking changes and an API Extractor baseline review; the pull request template repeats the checklist.


    No es suficiente para una insignia.

    El sistema de control de versiones DEBE requerir que todos los colaboradores de código afirmen que están legalmente autorizados para realizar las contribuciones asociadas en cada confirmación (commit). [OSPS-LE-01.01]
    Incluya un DCO en el repositorio del proyecto, requiriendo que los contribuidores de código afirmen que están legalmente autorizados para confirmar las contribuciones asociadas en cada commit. Use una verificación de estado para asegurar que se haga la afirmación. Un CLA también satisface este requisito. Algunos sistemas de control de versiones, como GitHub, pueden incluir esto en los términos de servicio de la plataforma.

    The DCO sign-off is documented in https://github.com/brazilian-utils/javascript/blob/main/CONTRIBUTING.md#commit-messages but no check enforces it yet, and recent commits carry no Signed-off-by line.


    ¡Suficiente para una insignia!

    Cuando se realiza un commit a la rama principal, cualquier verificación de estado automatizada para commits DEBE pasar o ser omitida manualmente. [OSPS-QA-03.01]
    Configure el sistema de control de versiones del proyecto para requerir que todas las verificaciones de estado automatizadas pasen o requieran reconocimiento manual antes de que un commit pueda fusionarse en la rama principal. Se recomienda que cualquier verificación de estado opcional NO esté configurada como un requisito de pasar o fallar que los aprobadores puedan estar tentados a omitir.

    The Check (format, lint, types, dependency and lockfile checks, API baseline, audit-ci), Tests, Build, Mutation tests and Security workflows run on every pull request and are required status checks on main; a merge with a failing check needs an explicit, audited administrator bypass.


    ¡Suficiente para una insignia!

    Antes de que se acepte un commit, los pipelines de CI/CD del proyecto DEBEN ejecutar al menos un conjunto de pruebas automatizado para asegurar que los cambios cumplan las expectativas. [OSPS-QA-06.01]
    Las pruebas automatizadas deben ejecutarse antes de cada fusión en la rama principal. El conjunto de pruebas debe ejecutarse en un pipeline de CI/CD y los resultados deben ser visibles para todos los contribuidores. El conjunto de pruebas debe ejecutarse en un entorno consistente y debe ejecutarse de manera que permita a los contribuidores ejecutar las pruebas localmente. Ejemplos de conjuntos de pruebas incluyen pruebas unitarias, pruebas de integración y pruebas de extremo a extremo.

    The Tests workflow runs the full vitest suite with coverage on every pull request (Node.js 20/22/24/26, Bun, Deno and Chrome/Firefox/Edge/Safari), and the Mutation tests workflow runs Stryker; both are required before merging.


    ¡Suficiente para una insignia!

    Cuando el proyecto ha realizado un lanzamiento, la documentación del proyecto DEBE incluir documentación de diseño que demuestre todas las acciones y actores dentro del sistema. [OSPS-SA-01.01]
    Incluya diseños en la documentación del proyecto que expliquen las acciones y los actores. Los actores incluyen cualquier subsistema o entidad que pueda influir en otro segmento del sistema. Asegúrese de que esto se actualice para nuevas características o cambios importantes.

    CONTRIBUTING.md "Architecture" describes the layout (src/<util>/, _internals, generated datasets), the rule that utilities are synchronous, stateless and side-effect free, the two utilities that perform network I/O and how they treat responses, the trust boundary of the published package, and the actors around the code (consumers, contributors, maintainers, CI, Dependabot, release-please).


    ¡Suficiente para una insignia!

    Cuando el proyecto haya realizado un lanzamiento, la documentación del proyecto DEBE incluir descripciones de todas las interfaces de software externas de los activos de software liberados. [OSPS-SA-02.01]
    Documente todas las interfaces de software (APIs) de los activos de software liberados, explicando cómo los usuarios pueden interactuar con el software y qué datos se esperan o se producen. Asegúrese de que esto se actualice para nuevas funcionalidades o cambios incompatibles.

    The package's only interface is its exported functions: docs/utilities.md documents every one with parameters, return values and examples, and the public API surface is checked in CI against the reviewed baseline reports/api/brazilian-utils.api.md (API Extractor). The only external interfaces the code itself calls, the public CEP APIs used by getAddressInfoByCep and getCepInfoByAddress, are described in those utilities' docs and in the Architecture section.


    ¡Suficiente para una insignia!

    Cuando el proyecto haya realizado un lanzamiento, el proyecto DEBE realizar una evaluación de seguridad para comprender los problemas de seguridad potenciales más probables e impactantes que podrían ocurrir dentro del software. [OSPS-SA-03.01]
    Realizar una evaluación de seguridad informa tanto a los miembros del proyecto como a los consumidores posteriores que el proyecto comprende qué problemas podrían surgir dentro del software. Comprender qué amenazas podrían materializarse ayuda al proyecto a gestionar y abordar el riesgo. Esta información es útil para los consumidores posteriores para demostrar la competencia y prácticas de seguridad del proyecto. Asegúrese de que esto se actualice para nuevas funcionalidades o cambios incompatibles.

    SECURITY.md "What's in scope" records the assessment for a zero-dependency utility library: the likely problems are unsafe behaviour of a validator or formatter on adversarial input (ReDoS, prototype pollution, dynamic code), the two utilities that consume external CEP APIs, and the integrity of the build and release tooling; the controls follow from it (mutation-tested suites, no runtime dependencies, SHA-pinned actions, OIDC publishing with provenance, workflow linting, OpenSSF Scorecard on every push).


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir una política de divulgación coordinada de vulnerabilidades (CVD), con un plazo claro de respuesta. [OSPS-VM-01.01]
    Cree un archivo SECURITY.md en la raíz del directorio, describiendo la política del proyecto para la divulgación coordinada de vulnerabilidades. Incluya un método para reportar vulnerabilidades. Establezca expectativas sobre cómo el proyecto responderá y abordará los problemas reportados.

    SECURITY.md "Response timeline" and "Disclosure": reports are acknowledged within 7 days, assessed within 14 days and fixed or mitigated within 90 days of confirmation; the reporter is kept informed, a new date is agreed when a fix needs longer, and the fix is released together with a GitHub Security Advisory.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE proporcionar un medio para reportar vulnerabilidades de forma privada directamente a los contactos de seguridad del proyecto. [OSPS-VM-03.01]
    Proporcione un medio para que los investigadores de seguridad reporten vulnerabilidades de forma privada al proyecto. Esto puede ser una dirección de correo electrónico dedicada, un formulario web, herramientas especializadas del VCS, direcciones de correo electrónico para contactos de seguridad, u otros métodos.

    SECURITY.md provides two private channels: GitHub Private Vulnerability Reporting on the repository (Security tab → "Report a vulnerability"), which opens a private thread with the maintainers, and the e-mail support@brazilian-utils.com.br.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE publicar públicamente los datos sobre las vulnerabilidades descubiertas. [OSPS-VM-04.01]
    Proporcione información sobre vulnerabilidades conocidas en un canal público predecible, como una entrada CVE, publicación de blog u otro medio. En la medida de lo posible, esta información debe incluir la(s) versión(es) afectada(s), cómo un consumidor puede determinar si es vulnerable, e instrucciones para la mitigación o remediación.

    SECURITY.md "Disclosure": every confirmed vulnerability is published as a GitHub Security Advisory with a CVE, listing affected and fixed versions and any workaround, at https://github.com/brazilian-utils/javascript/security/advisories. None has been reported to date.



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.