zerodep.app

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 9225 is passing Here is how to embed it:

These are the Passing level criteria. You can also view the Silver or Gold level criteria.

        

 Basics 13/13

  • Identification

    A modern library of high quality, zero-dependency, fully typed, tree-shakeable utilities, parsers, data structure factories, converters and other capabilities to help in crafting quality Node.js/Bun and JavaScript/TypeScript applications quickly.

    What programming language(s) are used to implement the project?
  • Basic project website content


    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]

    https://zerodep.app

    A modern library of high quality, zero-dependency, fully typed, tree-shakeable utilities, parsers, data structure factories, converters and other capabilities to help in crafting quality Node.js/Bun and JavaScript/TypeScript applications quickly.



    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    Habari juu ya jinsi ya kuchangia LAZIMA ieleze mchakato wa uchangiaji (kwa mfano, je! Maombi ya kuvuta yanatumika?) (URL required) [contribution]

    Non-trivial contribution file in repository: https://github.com/cdepage/zerodep/blob/main/CONTRIBUTING.md.



    Habari juu ya jinsi ya kuchangia INAPASWA kujumuisha mahitaji ya michango inayokubalika (k.m., rejeleo la kiwango chochote kinachohitajika cha usimbaji). (URL required) [contribution_requirements]
  • FLOSS license

    What license(s) is the project released under?



    The software produced by the project MUST be released as FLOSS. [floss_license]

    The MIT license is approved by the Open Source Initiative (OSI).



    It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]

    The MIT license is approved by the Open Source Initiative (OSI).



    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]

    Non-trivial license location file in repository: https://github.com/cdepage/zerodep/blob/main/LICENSE.md.


  • Documentation


    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]

    The https://zerodep.app website explains in great detail each capability of the software.



    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]

    The following explain how to use the software: - https://zerodep.app/ - https://github.com/cdepage/zerodep/tree/main/docs


  • Other


    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]

    The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. [discussion]

    GitHub supports discussions on issues and pull requests.



    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]

    Full software documentation, how to contribute and report issues may be found at: - https://zerodep.app/ - https://github.com/cdepage/zerodep/issues - https://github.com/cdepage/zerodep/discussions



    The project MUST be maintained. [maintained]

    The project is updated regularly with new features/capabilities as-needed. Updates also occur as new LTS versions of Node.js are released. Tooling used to manage the monorepo and build pipeline are regularly updated. - https://github.com/cdepage/zerodep/releases



(Advanced) What other users have additional rights to edit this badge entry? Currently: []



  • Public version-controlled source repository


    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]

    Repository on GitHub, which provides public git repositories with URLs.



    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.



    To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]

    Repository on GitHub leverages both tags and branches. The next branch is intended as an interim branch before a public release.



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.


  • Unique version numbering


    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]

    This project follows semantic versioning practices: - https://github.com/cdepage/zerodep/releases - https://zerodep.app/#/CHANGELOG



    It is SUGGESTED that the Semantic Versioning (SemVer) or Calendar Versioning (CalVer) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value. [version_semver]


    It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags]

    This project follows semantic versioning practices - https://github.com/cdepage/zerodep/releases


  • Release notes


    The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes]

    The project follows semantic versioning in their release notes. - https://github.com/cdepage/zerodep/releases - https://zerodep.app/#/CHANGELOGund.



    The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created. This criterion may be marked as not applicable (N/A) if users typically cannot practically update the software themselves (e.g., as is often true for kernel updates). This criterion applies only to the project results, not to its dependencies. If there are no release notes or there have been no publicly known vulnerabilities, choose N/A. [release_notes_vulns]
  • Bug-reporting process


    The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process]

    The zerodep.app project is hosted on GitHub. The issues capabilities of GitHub are enabled. See: - https://github.com/cdepage/zerodep/issues



    The project SHOULD use an issue tracker for tracking individual issues. [report_tracker]

    The zerodep.app project is hosted on GitHub. The issues capabilities of GitHub are enabled. See: - https://github.com/cdepage/zerodep/issues



    The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]

    The zerodep.app project is hosted on GitHub. The issues capabilities of GitHub are enabled. GitHub labels are used to identify which issues will be addressed. See: - https://github.com/cdepage/zerodep/issues



    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]

    The zerodep.app project is hosted on GitHub. The issues capabilities of GitHub are enabled. To date, the majority of issues have been closed within days. - https://github.com/cdepage/zerodep/issues?q=is%3Aissue+is%3Aclosed



    The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive]

    The zerodep.app project is hosted on GitHub. The issues capabilities of GitHub are enabled. This archive is searchable. See: - https://github.com/cdepage/zerodep/issues?q=is%3Aissue+is%3Aclosed


  • Vulnerability report process


    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]

    Project is hosted on GitHub and has "private reporting of security vulnerability" enabled. Documentation also clearly specifies the protocol to follow when reporting vulnerabilities. See: - https://github.com/cdepage/zerodep/blob/main/SECURITY.md - https://github.com/cdepage/zerodep/security



    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]

    Project is hosted on GitHub and has "private reporting of security vulnerability" enabled - https://github.com/cdepage/zerodep/blob/main/SECURITY.md - https://github.com/cdepage/zerodep/security



    The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. [vulnerability_report_response]

    The zerodep.app project is hosted on GitHub and has Snyk monitoring enabled. See: - https://github.com/cdepage/zerodep/issues?q=is%3Aissue+is%3Aclosed - https://snyk.io/test/github/cdepage/zerodep


  • Working build system


    Ikiwa programu iliyotengenezwa na mradi inahitaji ujenzi wa matumizi, mradi LAZIMA utoe mfumo wa kujenga ambao unaweza kujenga programu kiotomatiki kutoka kwa chanzo-msimbo. [build]

    The software produced by the project is available via NPM: - https://www.npmjs.com/search?q=%40zerodep

    Local builds may be created from the source code via an NPM script command: - npm run buld:all



    INAPENDEKEZWA kuwa zana za kawaida zitumike kujenga programu. [build_common_tools]

    The software leverages the popular NX monorepo management and Vite build tools for creating ESM and CJS packages.



    Mradi UNAPASWA kujengwa kwa kutumia zana za FLOSS pekee yake. [build_floss_tools]

    The software leverages the popular NX monorepo management and Vite build tools, both are FLOSS tools.


  • Automated test suite


    The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]

    Local builds may be created from the source code via an NPM script command within the repository. No external project is required. GitHub actions are also used in a CI/CD capacity. All tests are publicly available and are co-located with the source code. Test scripts, including determining code test coverage may be run via typical NPM scripts: - npm run test:all - npm run buld:all



    A test suite SHOULD be invocable in a standard way for that language. [test_invocation]

    All tests are publicly available and are co-located with the source code. Test scripts, including determining code test coverage may be run via typical NPM scripts: - npm run test:all - npm run buld:all



    It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. [test_most]

    All tests are publicly available and are co-located with the source code. Test scripts, including determining code test coverage may be run via typical NPM scripts: - npm run test:all - npm run coverage:all



    It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). [test_continuous_integration]

    GitHub actions are also used in a CI/CD capacity that lints, tests and builds the software with each commit. - https://github.com/cdepage/zerodep/blob/main/.github/workflows/ci.yml


  • New functionality testing


    The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy]

    The project is hosted on GitHub. Part of the project includes a file outlining the the requirements for having new or improved code merged in. This file is referenced in numerous places - https://github.com/cdepage/zerodep/blob/main/CONTRIBUTING.md



    The project MUST have evidence that the test_policy for adding tests has been adhered to in the most recent major changes to the software produced by the project. [tests_are_added]

    The project is hosted on GitHub. All pull requests to add/update code to the system pass through both manual and automated objective quality gates ensuring the test policy is enforced. - https://github.com/cdepage/zerodep/blob/main/CONTRIBUTING.md



    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]

    The project is hosted on GitHub. Part of the project includes a file outlining the the requirements for having new or improved code merged in. This file is referenced in numerous places - https://github.com/cdepage/zerodep/blob/main/CONTRIBUTING.md


  • Warning flags


    The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. [warnings]

    The project is hosted on GitHub. Build tooling includes linting tools that includes strict requirements related to common coding practices. The CI pipeline includes automatic quality checks by CodeCover: - https://www.codefactor.io/repository/github/cdepage/zerodep



    The project MUST address warnings. [warnings_fixed]

    Build tooling includes linting tools that includes strict requirements related to common coding practices. The CI pipeline will automatically prevent merging of any code that has either warnings or errors.



    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    Build tooling includes linting tools that includes strict requirements related to common coding practices. The CI pipeline will automatically prevent merging of any code that has either warnings or errors.


  • Secure development knowledge


    The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]

    Maintainers of this software are well-versed in common software vulnerabilities. The software produced by the code is intended to assist other developers in their own projects to be safer, especially by limiting supply-chain attacks.



    At least one of the project's primary developers MUST know of common kinds of errors that lead to vulnerabilities in this kind of software, as well as at least one method to counter or mitigate each of them. [know_common_errors]

    Maintainers of this software are well-versed in common software vulnerabilities. The software produced by the code is intended to assist other developers in their own projects to be safer, especially by limiting supply-chain attacks and by providing functionality to mitigate many of JavaScript's quirks that may allow malicious behaviour to be successful.


  • Use basic good cryptographic practices

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    Programu iliyotengenezwa na mradi LAZIMA itumie, kwa chaguo-msingi, tu itifaki za kriptografia na mifumbo ambazo zimechapishwa hadharani na kukaguliwa na wataalam (ikiwa itifaki za kriptografia na mafumbo imetumika). [crypto_published]

    This software does provide nor rely upon any cryptographic algorithms nor are there any need for them.



    Ikiwa programu iliyotengenezwa na mradi ni programu au maktaba, na kusudi lake la msingi sio kutekeleza usimbuaji, basi INAPASWA tu kuita programu iliyoundwa kihususa kutekeleza kazi za kielelezo; HAIPASWI kutekeleza-upya shughuli hiyo. [crypto_call]

    This software does not provide anything requiring cryptography (not even random number generation, or hashing) - should that ever be the case the primary maintainer knows better than to try to reinvent that wheel.



    Utendaji wote katika programu iliyotengenezwa na mradi ambayo inategemea usimbuaji LAZIMA iweze kutekelezwa kwa kutumia FLOSS. [crypto_floss]

    The intention of this project is to be opensource, only solutions that allow free (beer + speech) will be used.



    Mifumo ya usalama ndani ya programu inayozalishwa na mradi LAZIMA itumie kwa msingi keylengths ambazo angalau zinakidhi mahitaji ya chini ya NIST kufikia mwaka wa 2030 (kama ilivyoelezwa mnamo 2012). LAZIMA iwe rahisi kusanidi programu ili keylengths ndogo zimezimwa kabisa. [crypto_keylength]

    This software does provide nor rely upon any cryptographic algorithms nor are there any need for them.



    The default security mechanisms within the software produced by the project MUST NOT depend on broken cryptographic algorithms (e.g., MD4, MD5, single DES, RC4, Dual_EC_DRBG), or use cipher modes that are inappropriate to the context, unless they are necessary to implement an interoperable protocol (where the protocol implemented is the most recent version of that standard broadly supported by the network ecosystem, that ecosystem requires the use of such an algorithm or mode, and that ecosystem does not offer any more secure alternative). The documentation MUST describe any relevant security risks and any known mitigations if these broken algorithms or modes are necessary for an interoperable protocol. [crypto_working]

    This software does provide nor rely upon any cryptographic algorithms nor are there any need for them.



    The default security mechanisms within the software produced by the project SHOULD NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). [crypto_weaknesses]

    This software does provide nor rely upon any cryptographic algorithms nor are there any need for them.



    Mifumo ya usalama ndani ya programu iliyotengenezwa na mradi INAPASWA kutekeleza kwa ukamilifu usiri wa umbele ya itifaki za makubaliano ya funguo ili funguo la kipindi kilicho tokana na kikao cha vifungo muda-mrefu haziwezi kuridhi mabaya ikiwa mojawapo ya vifunguo vya muda-mrefu imeridhi mabaya katika usoni. [crypto_pfs]

    This software does provide nor rely upon any cryptographic algorithms nor are there any need for them.



    Ikiwa programu iliyotengenezwa na mradi imesababisha uhifadhi wa nywila kwa minajili ya uthibitishaji ya watumiaji wa kutoka nje, nywila LAZIMA zihifadhiwe kwa mficho uliorudiarudia na chumvi kwa kila-mtumiaji kwa kutumia kanuni ya upanuaji (rudiarudia) wa funguo (k.m., Argon2id, Bcrypt, Scrypt, or PBKDF2). Ona pia Kurasadogo ya Uhifadhi wa Nywila la OWASP). [crypto_password_storage]

    This software does provide nor rely upon any cryptographic algorithms nor are there any need for them.



    Mifumo ya usalama ndani ya programu iliyotengenezwa na mradi LAZIMA itoe funguo zote za kriptologia na nonces kwa kutumia kitengeneza cha nambari za bahati kuptia kriptologia salama, na ISIWEZE kufanya hivo kutumia vitengenezi zisizo salama kikriptologia. [crypto_random]

    This software does provide nor rely upon any cryptographic algorithms nor are there any need for them.


  • Secured delivery against man-in-the-middle (MITM) attacks


    The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]

    Software build by this project are intended to be distributed via npm .



    A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned]

    Software build by this project are intended to be distributed via npm .


  • Publicly known vulnerabilities fixed


    There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]

    The libraries/packages created by this software have no known vulnerabilities. - https://snyk.io/test/github/cdepage/zerodep



    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

    Snyk monitoring results in immediate notifications of any vulnerabilities to the package maintainer. - https://snyk.io/test/github/cdepage/zerodep


  • Other security issues


    The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]

    This software does not use/require any credentials. All github and npm access require 2FA.


  • Static code analysis


    At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. [static_analysis]

    This project leverages eslint (with sonar plugins strictly configured) enable local and CI pipeline static code analysis. The CI pipeline also leverages CodeFactor and Snyk to enforce minimum code quality and security requirements.



    It is SUGGESTED that at least one of the static analysis tools used for the static_analysis criterion include rules or approaches to look for common vulnerabilities in the analyzed language or environment. [static_analysis_common_vulnerabilities]

    This project leverages eslint (with sonar plugins strictly configured) enable local and CI pipeline static code analysis. The CI pipeline also leverages CodeFactor and Snyk to enforce minimum code quality and security requirements.



    All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [static_analysis_fixed]

    This project uses Snyk monitoring notifies project maintainers of any vulnerabilities both in the source code and any build tool dependencies. Any vulnerabilities are triaged to have near-immediate investigation and remediation.



    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]

    This project uses Snyk and CodeFactor to enforce strict quality and security metrics, these are triggered on every commit.


  • Dynamic code analysis


    It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. [dynamic_analysis]

    This project has comprehensive unit testing that exercise the code against the full range of input types found within a TypeScript/JavaScript environment. Full details may be found within each test co-located with the source code: - https://github.com/cdepage/zerodep/tree/main/packages



    It is SUGGESTED that if the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). [dynamic_analysis_unsafe]

    This project is written in TypeScript. The build tooling (a combination of Rust and TypeScript/JavaScript) produces artifacts that are uploaded to NPM for distribution. These build artifacts have a hash associated with them that is used by the NPM ecosystem. Packages may be found at: - https://www.npmjs.com/search?q=%40zerodep



    It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing) which enables many assertions. In many cases these assertions should not be enabled in production builds. [dynamic_analysis_enable_assertions]

    This project has comprehensive unit testing that exercise the code against the full range of input types found within a TypeScript/JavaScript environment. Full details may be found within each test co-located with the source code: - https://github.com/cdepage/zerodep/tree/main/packages



    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. [dynamic_analysis_fixed]

    The CI pipeline of the project will not permit the completion of a build pipeline if any of the tests fail, this includes third-party code analysis via CodeFactor and Snyk.



This data is available under the Creative Commons Attribution version 3.0 or later license (CC-BY-3.0+). All are free to share and adapt the data, but must give appropriate credit. Please credit Chris dePage and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Chris dePage.
Entry created on 2024-07-20 16:07:08 UTC, last updated on 2024-07-21 00:02:23 UTC. Last achieved passing badge on 2024-07-20 20:30:07 UTC.

Back