OWASP VulnerableApp is a modular deliberately vulnerable application designed primarily for validating and benchmarking security scanners through reproducible test scenarios, while also supporting learning and experimentation.
The simplest way to run the project is using Docker containers which will run the full-fleged VulnerableApplication with all the components. For running as Docker application, follow following steps:
Open the terminal and Navigate to the Project root directory
Run the command docker-compose pull && docker-compose up
Navigate to browser and visit http://localhost and this will give the User Interface for VulnerableApp.
Note: The above steps will run the latest unreleased VulnerableApp version. If you want to run the latest released version, please use docker latest tag.
Another way to run the VulnerableApp is as standalone Vulnerable Application is:
Navigate to Releases Sectionโ in github and download the Jar for the latest released version
Open the terminal and navigate to the project root directory
Run the command java -jar VulnerableApp-*
Navigate to browser and visit http://localhost:9090/VulnerableApp. This will give the Legacy User Interface for the VulnerableApp.
There are 2 ways in which this project can be built and used:
As a Docker application which will help in running the full-fledged VulnerableApplication. For running as Docker application, follow following steps:
Build the docker image by running ./gradlew jibDockerBuild
Download Docker-Composeโ and run in the same directory docker-compose up
Navigate to browser and visit http://localhost and this will give the User Interface for VulnerableApp.
As a SpringBoot application which will run with the Legacy UI or Rest API but gives the benefit of debugging and solving issues. This is the simple way,
Import the project into your favorite IDE and run it
Navigate to browser and visit: http://localhost:9090/VulnerableApp and this will give the Legacy User Interface for VulnerableApp which you can use to debug and test.
There are multiple ways in which you can contribute to the project:
If you are a developer and trying to start on to the project, then the suggestion is to go through the list of issuesโ which contains good first issue which can be a good starter.
If you are a developer or a security professional looking to add new Vulnerability type then you can Generate the Sample Vulnerability by running ./gradlew GenerateSampleVulnerability. It will generate the Sample Vulnerability template which has placeholders and comments. Modified files can be seen in the logs of the command or in the github history. You can navigate to those files, fill in the placeholders and then build the project to see the effect of the changes.
In case you are looking to contribute to the project by publicising it or working on the growth of the project, please feel free to add your thoughts to discussions section or issues and we can discuss over them.
VulnerableApp-facade provides a modern UI for VulnerableApp. To test your local changes with the Modern UI:
Prerequisite: Ensure you have Docker and Docker-Compose installed.
Run Testing Script:
On Windows: .\scripts\testWithModernUI.bat
On Linux/Mac: ./scripts/testWithModernUI.sh
This script will build your local changes into a Docker image (sasanlabs/owasp-vulnerableapp:unreleased) and start the full stack (including facade, jsp, and php services) using docker-compose.local.yml.
Access the UI: Navigate to http://localhost to see the modern UI with your changes.
In case you are stuck with any of the steps or understanding anything related to project and its goals, feel free to shoot a mail at [email protected]โ or raise an issueโ and we will try our best to help you.