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 Silver level criteria. You can also view the Passing or Gold level criteria.

        

 Basics 8/17 ●

  • Identification

    OWASP Project Developer Guide - Document and Project Web pages

  • Prerrequisitos


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

    The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (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


  • Supervisión del proyecto


    Unknown required information, not enough for a badge.

    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]

    Unknown required information, not enough for a badge.

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]

    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]

    The developer guide code of conduct is at: https://github.com/OWASP/www-project-developer-guide/blob/main/code_of_conduct.md


    Unknown required information, not enough for a badge.

    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]

    Enough for a badge!

    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    The OWASP Developer Guide project has 5 leaders who all have full administration rights. If any of these leaders are incapacitated then the other leaders are able to create and close issues, accept proposed changes, and release versions of software: https://github.com/OWASP/www-project-developer-guide/blob/main/leaders.md In addition the project is in the OWASP organization repository area, and the OWASP executive have administration right s for all aspects of the project


    Enough for a badge!

    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]

    The OWASP Developer Guide project has 5 project leaders all with full admin rights to the repository: https://github.com/OWASP/www-project-developer-guide/blob/main/leaders.md In addition the OWASP foundation also has admin rights to the github OWASP organization area, which encompasses the Developer Guide, and so even if all 5 leaders were to become unavailable all files would still be fully accessible by the OWASP organization


  • Documentation


    Unknown required information, not enough for a badge.

    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]

    Enough for a badge!

    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]

    The OWASP Developer Guide project does not produce software as it is a documentation project


    Unknown required information, not enough for a badge.

    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]

    Unknown required information, not enough for a badge.

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]

    Unknown required information, not enough for a badge.

    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]

    Enough for a badge!

    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]

    The read-me file shows the best practices badge, and this was done on the same day that it was awarded: https://github.com/OWASP/www-project-developer-guide/blob/main/README.md


  • Accessibility and internationalization


    Unknown required information, not enough for a badge.

    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]

    Unknown required information, not enough for a badge.

    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]

  • Other


    Enough for a badge!

    If the project sites (website, repository, and download URLs) store passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]

    The OWASP Developer Guide project does not store passwords; it is a documentation project only


  • Versiones anteriores


    Enough for a badge!

    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    all previous versions of the latest OWASP Developer Guide incarnation are available here, for all time: https://github.com/OWASP/www-project-developer-guide/releases


  • Bug-reporting process


    Enough for a badge!

    The project MUST 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


  • Proceso de informe de vulnerabilidad


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    There have been no vulnerabilities resolved in the last 12 months


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]

    The process for reporting vulnerabilities for the Developer Guide project is described in security policy at : https://github.com/OWASP/www-project-developer-guide/blob/main/security.md


  • Coding standards


    Enough for a badge!

    The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards]

    The OWASP Developer Guide is a documentation project written in Markdown. The contributor guide specifies that contributions to the Developer Guide content must be in Markdown : https://github.com/OWASP/www-project-developer-guide/blob/main/contributing.md


    Enough for a badge!

    The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced]

    The OWASP Developer Guide is a documentation project written in Markdown. Contributions to the Developer Guide content are made via github pull request , and the pull requests are checked and enforced for Markdown coding style, spelling and URL links - this is enforced using a github workflow at : https://github.com/OWASP/www-project-developer-guide/blob/main/.github/workflows/pr.yaml


  • Working build system


    Enough for a badge!

    Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables]

    The OWASP Developer Guide project does not produce software as it is a documentation project


    Enough for a badge!

    The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_preserve_debug]

    The OWASP Developer Guide project does not produce software as it is a documentation project


    Enough for a badge!

    The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive]

    The OWASP Developer Guide project build / installation uses the Jekyll static site builder to provide the web document from markdown source files, and this does not recursively build subdirectories


    Enough for a badge!

    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]

    The OWASP Developer Guide project is written in markdown, which in turn is used to create the web document, PDF and ePub files. These are created and are repeatable using the release pipeline at : https://github.com/OWASP/www-project-developer-guide/blob/main/.github/workflows/release.yaml


  • Installation system


    Enough for a badge!

    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]

    This is a documentation project taking the form of PDF, ePub and web document; as such it does not have an installation process, just a simple download of a file in standard format


    Enough for a badge!

    The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). [installation_standard_variables]

    This is a documentation project taking the form of PDF, ePub and web document; as such it does not have an installation process, just a simple download of a file in standard format. The download location can be selecte dby the user


    Enough for a badge!

    The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick]

    This is a documentation project taking the form of PDF, ePub and web document; as such it does not have an installation process, just a simple download of a file in standard format. There is no test environment although markdown parsing, link checking and spell checking is done on both pull request and commit


  • Externally-maintained components


    Enough for a badge!

    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]

    This is a documentation project taking the form of PDF, ePub and web document; there are no external dependencies


    Enough for a badge!

    Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring]

    There are no external dependencies


    Enough for a badge!

    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]

    There are no external dependencies


    Enough for a badge!

    The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current]

    The OWASP Developer Guide project is does not use APIs


  • Automated test suite


    Enough for a badge!

    An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing]

    There is an automated pipeline / workflow that checks markdown parsing, link checking and spell checking - 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


    Enough for a badge!

    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    This is a documentation project taking the form of PDF, ePub and web document; as such it does not have an any regression tests that can be practical


    Enough for a badge!

    The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80]

    There is an automated pipeline / workflow that checks markdown parsing, link checking and spell checking - 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 these check 100% of the markdown source used to create the Developer Guide document


  • New functionality testing


    Enough for a badge!

    The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated]

    This is a documentation project that does not have an automated test suite


    Enough for a badge!

    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [tests_documented_added]

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


  • Banderas de advertencia


    Enough for a badge!

    Projects MUST 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


  • Conocimiento de desarrollo seguro


    Enough for a badge!

    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]

    The OWASP Developer Guide does not produce software - it is a documentation project that is built from markdown files with PDF and ePub generation


  • Use buenas prácticas criptográficas

    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.

    Enough for a badge!

    The default security mechanisms within the software produced by the project MUST 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


    Enough for a badge!

    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

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


    Enough for a badge!

    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

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


    Enough for a badge!

    The software produced by the project SHOULD support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 SHOULD be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

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


    Enough for a badge!

    The software produced by the project SHOULD, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

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


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]

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


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

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


  • Secure release


    Unknown required information, not enough for a badge.

    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]

    Unknown required information, not enough for a badge.

    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

  • Otros problemas de seguridad


    Enough for a badge!

    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]

    The OWASP Developer Guide project is a documentation project, and as such does not have input from sources (untrusted or not)


    Enough for a badge!

    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]

    The OWASP Developer Guide project is a documentation project hosted by the OWASP organization itself, and as such does not require hardening mechanisms: https://owasp.org/www-project-developer-guide/


    Unknown required information, not enough for a badge.

    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]

  • Análisis estático de código


    Enough for a badge!

    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [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


  • Dynamic code analysis


    Enough for a badge!

    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) MUST 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



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