OWASP Developer Guide

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 9373 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

    OWASP Project Developer Guide - Document and Project Web pages

    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]

    The developer guide is described in the landing page at https://owasp.org/www-project-developer-guide/



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

    there is a code of conduct and also contributing guidelines which provide style and document structure suggestions: https://owasp.org/www-project-developer-guide/contributing.md https://owasp.org/www-project-developer-guide/code_of_conduct.md



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

    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]

    As well as the contributing guidelines, any pull requests are subject to a linting process, a spellchecker and a link checker. These are applied as part of the pull request mechanism at : https://github.com/OWASP/www-project-developer-guide/blob/main/.github/workflows/pr.yaml and also with any commits to main branch: https://github.com/OWASP/www-project-developer-guide/blob/main/.github/workflows/ci.yaml


  • FLOSS license

    What license(s) is the project released under?



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

    released under the Creative Commons Attribution 4.0 International License : https://web.archive.org/web/20230202005829/https://creativecommons.org/licenses/by/4.0/ which is an open source licence also used by the OpenSSF



    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 Creative Commons Attribution 4.0 International License : https://web.archive.org/web/20230202005829/https://creativecommons.org/licenses/by/4.0/ is an open source licence also used by the OpenSSF, although it is not listed by the 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/OWASP/www-project-developer-guide/blob/main/license.txt.


  • Documentation


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

    This is a documentation project with a release area: https://github.com/OWASP/DevGuide/wiki#old-versions and a draft area: https://owasp.org/www-project-developer-guide/draft



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

    This is a documentation project with releases in PDF, eBook and web - links to all of these are provided from the main page: https://owasp.org/www-project-developer-guide/release


  • Other


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

    Given only https: URLs.



    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]

    The documentation to the developer guide is at : https://owasp.org/www-project-developer-guide/ bug reports and comments are submitted via github issues and the github wiki: https://github.com/OWASP/www-project-developer-guide/issues https://github.com/OWASP/www-project-developer-guide/wiki



    The project MUST be maintained. [maintained]

    The project has commits to the repository every week, and has a release area listing recent releases: https://github.com/OWASP/www-project-developer-guide/releases



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



This is an OWASP project hosted on github. It is a documentation project that is mainly read via the web version, but it also has downloads in PDF and eBook format

  • 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: https://github.com/OWASP/www-project-developer-guide



    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: https://github.com/OWASP/www-project-developer-guide/commits/main/ 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]

    The documented release process requires interim versions, or release candidates, for review between releases : https://github.com/OWASP/www-project-developer-guide/blob/main/release-process.md



    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]

    The developer guide uses semver (semantic versioning) for its versioning system, as seen in the release area: https://github.com/OWASP/www-project-developer-guide/releases



    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]

    git tags are used to identify the release versions (and release candidates) of the developer guide: https://github.com/OWASP/www-project-developer-guide/tags


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

    They are not released as separate files, but are added to the release area itself in the description for each release as text tailored for the individual release, for example: https://github.com/OWASP/www-project-developer-guide/releases/tag/4.1.3



    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]

    So far no publicly known vulnerabilities or even publicly unknown ones There is a security policy process for raising security issues with the project : https://github.com/OWASP/www-project-developer-guide/blob/main/security.md


  • 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 project SHOULD use an issue tracker for tracking individual issues. [report_tracker]

    Yes, GitHub issue tracker provides this : https://github.com/OWASP/www-project-developer-guide/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 project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]

    the large majority of issues are closed with a few months: https://github.com/OWASP/www-project-developer-guide/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]

    Yes, GitHub issue tracker provides a publicly available archive for issues and responses : https://github.com/OWASP/www-project-developer-guide/issues


  • Vulnerability report process


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

    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]

    the security policy process provides this using the GitHub security advisories feature: https://github.com/OWASP/www-project-developer-guide/security/advisories/new



    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]

    no vulnerability reports received yet, but the project leaders have state dthat they will fix any as a priority: https://github.com/OWASP/www-project-developer-guide/blob/main/security.md


  • 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 release pipeline rebuilds the web document, along with PDF and eBook files. The pull-request pipeline provides PDF and eBook files, the commit pipeline rebuilds the web document.



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

    github actions within the pipelines are used to build the web document, as well as PDF and eBook files https://github.com/OWASP/www-project-developer-guide/tree/main/.github/workflows



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

    all github workflow actions used by the pipelines are FLOSS


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

    There is no running application that an automated test suit can scan The automated tests applied by the pipelines are link checks, spell checks and markdown lint



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

    The automated tests applied by the pipelines (link checks, spell checks and markdown lint) are invoked in a standard way from the command line or from a github action. This is done on both pull request and commit: https://github.com/OWASP/www-project-developer-guide/blob/main/.github/workflows/ci.yaml https://github.com/OWASP/www-project-developer-guide/blob/main/.github/workflows/pr.yaml



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

    The automated tests applied by the pipelines (link checks, spell checks and markdown lint) are applied to all markdown source files



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

    There is no running application that can have functional / unit test applied by an automated test suite Automated tests are applied on pull-requests to check new contributions.



    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]

    There is no running application that can have functional / unit test applied by an automated test suite. Automated tests are applied on pull-requests, commit to main branch and nightly CI pipelines



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

    The pull request template advises the contributor that the automated tests will be run on the pull-request


  • 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 markdown linter is used to detect code quality errors and common simple mistakes. The linter is FLOSS



    The project MUST address warnings. [warnings_fixed]

    Warnings from the link checker, markdown linter and spellchecker are treated as errors, and must be addressed before the pipeline can complete successfully



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

    The markdown linter is strict, where practical, using configuration file .markdownlint.yaml : https://github.com/OWASP/www-project-developer-guide/blob/main/.markdownlint.yaml


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

    The OWASP Developer Guide is a documentation project on how to design secure software. The leaders and contributors therefore have extensive knowledge on how to design secure software.



    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]

    The OWASP Developer Guide is a documentation project that covers common kinds of errors that lead to vulnerabilities. The leaders and contributors therefore have this knowledge to be able to write the Developer Guide.


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

    The OWASP Developer Guide is a documentation project with no cryptographic functionality



    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]

    The OWASP Developer Guide is a documentation project with no cryptographic functionality



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

    The OWASP Developer Guide is a documentation project with no cryptographic functionality



    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]

    The OWASP Developer Guide is a documentation project with no cryptographic security mechanisms



    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]

    The OWASP Developer Guide is a documentation project with no cryptographic security mechanisms



    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]

    The OWASP Developer Guide is a documentation project with no cryptographic security mechanisms



    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]

    The OWASP Developer Guide is a documentation project with no cryptographic security mechanisms



    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]

    The OWASP Developer Guide is a documentation project with no storage of passwords



    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]

    The OWASP Developer Guide is a documentation project with no cryptographic security mechanisms


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

    The web document is accessed via https



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

    The OWASP Developer Guide is a documentation project with no cryptographic hash es being used


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

    No security vulnerabilities of medium or higher severity, or of any priority, have been raised against this project



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

    There is a security policy process for raising security issues with the project, and the leaders undertake to fix any security vulnerabilities as a priority : https://github.com/OWASP/www-project-developer-guide/blob/main/security.md


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

    there are no credentials of any sort (test or otherwise) in the repo


  • 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 is a documentation project written in markdown for a Jekyll server. Static code analysis is provided by a markdown linter that is run by a nightly pipeline as well as on pull-request and commits to the main branch.



    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]

    The static code analysis provided by the markdown linter looks for common vulnerabilities in markdown. There is also a spell-checker and a link-checker that are run on a nightly basis as well as on commit and pull-request



    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]

    There is a security policy process for raising security issues with the project, and the leaders undertake to fix any security vulnerabilities as a priority : https://github.com/OWASP/www-project-developer-guide/blob/main/security.md



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

    Static code analysis is provided by a markdown linter that is run by a nightly pipeline as well as on pull-request and commits to the main branch.


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

    The OWASP Developer Guide is not an application that runs dynamically, it is a web document that is browsed as part of the OWASP web site: https://owasp.org/www-project-developer-guide/release/



    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]

    There is no C/C++ code or any other memory-unsafe language used for the Developer Guide



    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]

    The OWASP Developer Guide is not an application that runs dynamically, it is a web document that is browsed as part of the OWASP web site: https://owasp.org/www-project-developer-guide/release/ as such there are no run-time assertions that are practical and no dynamic analysis



    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]

    So far no publicly known medium and higher severity exploitable vulnerabilities or even low ones There is a security policy process for raising security issues with the project, and the leaders undertake to fix any security vulnerabilities as a priority : https://github.com/OWASP/www-project-developer-guide/blob/main/security.md



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Jon Gadsden and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Jon Gadsden.
Entry created on 2024-08-18 15:47:21 UTC, last updated on 2025-01-25 16:43:00 UTC. Last achieved passing badge on 2024-08-19 19:44:49 UTC.

Back