OWASP Juice Shop

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 223 is gold Here is how to embed it:

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

        

 Basics 17/17 ●

  • Identification

    OWASP Juice Shop is probably the most modern and sophisticated insecure web application! It can be used in security trainings, awareness demos, CTFs and as a guinea pig for security tools! Juice Shop encompasses vulnerabilities from the entire OWASP Top Ten along with many other security flaws found in real-world applications!

  • Prerequisites


    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]

    Contribution Guidelines: https://pwning.owasp-juice.shop/part3/contribution.html


  • Project oversight


    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]

    The OWASP Foundation provides a generic CLA: https://www.owasp.org/index.php/Contributor_License_Agreement


    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]

    The OWASP Foundation promotes an open governance model for its projects where contributions are welcome and project leaders are empowered to organize the project-internal governance as long as it is not in conflict with OWASP's mission: https://www.owasp.org/index.php/Category:OWASP_Project.

    In the OWASP Juice Shop governance happens by reviewing and ultimately merging or rejecting Pull Requests based on the criteria laid out in the Contribution Guidelines (https://bkimminich.gitbooks.io/pwning-owasp-juice-shop/content/part3/contribution.html) and according the the Project Roadmap (https://www.owasp.org/index.php/OWASP_Juice_Shop_Project#tab=Road_Map_and_Getting_Involved). The final say is with the Project Leader.


    Enough for a badge!

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

    Code of Conduct based on Contributor Covenant: https://github.com/bkimminich/juice-shop/blob/master/CODE_OF_CONDUCT.md


    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]

    The project site names Björn Kimminich as Project Leader (https://github.com/bkimminich/juice-shop#collaborators) and refers to OWASP's role definition: https://www.owasp.org/index.php/Projects/Project_Leader_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]

    Two Collaborators are named (https://github.com/bkimminich/juice-shop#collaborators) who have permissions that allow continuation of the project even if the account owner is incapacitated: https://help.github.com/articles/permission-levels-for-a-user-account-repository/#collaborator-access-on-a-repository-owned-by-a-user-account. Limitation: Changes of the Travis CI integration and associated 3rd party services (e.g. CodeClimate) would not be possible.


    Enough for a badge!

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

    The "bus factor" of OWASP Juice Shop is calculated as 1 by the truck-factor tool*. The constant maintainability "A"-grade and test coverage "A"-grade of CodeClimate (https://codeclimate.com/github/bkimminich/juice-shop) as well as the extensive documentation (https://pwning.owasp-juice.shop/part3/codebase.html) would allow others to pick up the project. OWASP as an organization also has experience in helping new Project Leaders to successfully take over an existing project.

    (*last checked on 04.04.2018)


  • Documentation


    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]

    Project Roadmap: https://www.owasp.org/index.php/OWASP_Juice_Shop_Project#tab=Road_Map_and_Getting_Involved


    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 high-level architecture is described in https://bkimminich.gitbooks.io/pwning-owasp-juice-shop/content/introduction/architecture.html and is broken down into a more detailed tier-by-tier explanation in https://bkimminich.gitbooks.io/pwning-owasp-juice-shop/content/part3/codebase.html.


    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]

    The catch phrase of the project clearly states that OWASP Juice Shop is an "intended vulnerable web application" (https://www.owasp.org/index.php/OWASP_Juice_Shop_Project) so users will expect built-in security vulnerabilities and should feel strongly discouraged to use it as "a best practice or template application for web developers" (https://bkimminich.gitbooks.io/pwning-owasp-juice-shop/content/).


    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]

    The different run options are described in the project README (https://github.com/bkimminich/juice-shop#setup) and online documentation (https://bkimminich.gitbooks.io/pwning-owasp-juice-shop/content/part1/running.html).


    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]

    Documentation for the latest official releasen is available online on GitBook: https://bkimminich.gitbooks.io/pwning-owasp-juice-shop/content The documentation repository uses the same GitFlow-based branching model - i.e. "master" (https://github.com/bkimminich/pwning-juice-shop/tree/master) for current release and "develop" (https://github.com/bkimminich/pwning-juice-shop/tree/develop) for latest snapshot - as the main repository.


    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]

    README (https://github.com/bkimminich/juice-shop/blob/master/README.md) and Contribution Guidelines (https://github.com/bkimminich/juice-shop/blob/master/CONTRIBUTING.md) contain all relevant badges abount project status and achievements.


  • Accessibility and internationalization


    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]

    The project site follows the standard layout of the OWASP Foundation. The application itself is occasionally checked for accessibility issues with Tenon.io: https://tenon.io/testNow.php?url=http://juice-shop.herokuapp.com


    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]

    The user interface of the application is translated into over 20 languages with varying degree of completion. At least English and German are guaranteed to be always available. Translation is crowdsourced on CrowdIn (https://crowdin.com/project/owasp-juice-shop) but can also be done directly via the code base as described in: https://bkimminich.gitbooks.io/pwning-owasp-juice-shop/content/part3/translation.html


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

    No credentials of external users are stored on any of the project sites.


  • Bug-reporting process


    Enough for a badge!

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

    Issues are tracked on GitHub: https://github.com/juice-shop/juice-shop/issues


  • Vulnerability report process


    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]

    The project had no "real" vulnerability reports in the last 12 months.*

    (*as of 04.04.2018)


    Enough for a badge!

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

    A security.txt file is generated on-the-fly with https://github.com/gergelyke/express-security.txt. This file is part of a hacking challenge and not to be taken serious. Any discovered unintended(!) security vulnerability should be reported via a GitHub issue instead: https://github.com/bkimminich/juice-shop/issues


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

    JavaScript Standard Style (https://standardjs.com/) is refered to from the Contribution Guideline: https://github.com/bkimminich/juice-shop/blob/master/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]

    JavaScript Standard Style (https://standardjs.com/) is enforced before unit test suite execution via the default test command: https://bkimminich.gitbooks.io/pwning-owasp-juice-shop/content/part3/contribution.html#javascript-standard-style-guide


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

    Not relevant for JavaScript 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]

    Not relevant for JavaScript 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]

    Not relevant for JavaScript project.


    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]

    Not relevant for JavaScript project.


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

    Installation from source is possible via NPM. Alternatively pre-packaged distributions are provided, also a Docker image and Vagrantfile are provided.


    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]

    Installation from source or pre-packaged distribution to any folder is possible,


    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]

    Installation from source is possible via NPM. Local execution of unit, API and e2e tests is possible via dedicated NPM scripts: https://bkimminich.gitbooks.io/pwning-owasp-juice-shop/content/part3/contribution.html#testing


  • Externally-maintained components


    Enough for a badge!

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

    External dependencies are declared in package.json file as per Node.js requirement. Server-tier requirements: https://github.com/bkimminich/juice-shop/blob/master/package.json Client-tier requirements: https://github.com/bkimminich/juice-shop/blob/master/app/package.json


    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]

    Gemnsium: https://gemnasium.com/bkimminich/juice-shop


    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]

    Dependency updates are monitored on Gemnasium (https://gemnasium.com/bkimminich/juice-shop) and also actively monitored, tested and brought into the codebase via Pull Requests using GreenKeeper: https://greenkeeper.io


    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]

    Deprecated core functionality of Node.js is not used.


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

    All test suites are executed on Travis CI where success/failure is reported: travis-ci.org/bkimminich/juice-shop The test coverage is reported into CodeClimate: https://codeclimate.com/github/bkimminich/juice-shop


    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]

    Regression tests are regularly added for fixed bugs.


    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]

    Unit and API tests combined provide >95% code coverage: https://codeclimate.com/github/bkimminich/juice-shop


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

    The Contribution Guidelines demand corresponding unit, integration and end-to-end tests for added functionality: https://bkimminich.gitbooks.io/pwning-owasp-juice-shop/content/part3/contribution.html#contribution-guidelines


    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]

    Part of contribution guidelines: https://github.com/juice-shop/juice-shop/blob/master/CONTRIBUTING.md


  • Warning flags


    Enough for a badge!

    Projects MUST be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    The JavaScript Standard Style Guide is enforced with a zero warnings policy.


  • Secure development knowledge


    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]

    Intended vulnerabilities that are potentially harmful in a non-local environment (e.g. DoS, RCE or XXE) are built into the application in a fail-safe mode. All other secure design violations are intentional.


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

    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]

    OWASP Juice Shop uses outdated and broken cryptography for some of its hacking challenges intentionally. Only the CTF flag codes are created using an actually safe HMAC with sha256. No cryptographic mechanisms are used otherwise for serious purposes.


    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]

    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]

    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]

    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]

    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]

    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]

  • Secure release


    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]

    All official releases are based on signed tags with the signature being verified by GitHub: https://github.com/bkimminich/juice-shop/releases


    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]

    All version tags are signed with the signature being verified by GitHub: https://github.com/bkimminich/juice-shop/releases


  • Other security issues


    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]

    OWASP Juice Shop fails at proper input validation on purpose to be able to provide corresponding hacking challenges.


    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]

    OWASP Juice Shop pins several outdated dependencues to make sure it keeps their known vulnerabilities to be able to provide corresponding hacking challenges.


    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]

    OWASP Juice Shop provides a thorough assurance case why it needs to fail at providing all the above: https://owasp-juice.shop


  • Static code analysis


    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]

    GitHub (https://github.com/juice-shop/juice-shop/network/alerts) scans with Dependabot for known vulnerable components being used as a software dependency.


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

    Not relevant for JavaScript project.



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 Björn Kimminich and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Björn Kimminich.
Entry created on 2016-06-22 08:31:10 UTC, last updated on 2021-12-30 08:33:04 UTC. Last lost passing badge on 2018-03-28 14:53:07 UTC. Last achieved passing badge on 2018-03-28 14:54:26 UTC.

Back